Documentation. (#12)

* First docs.

* Docs requirements.

* Add auto-generated gallery and fix two bugs in the driver.

* Gallery: link directly to github.

* Tag examples as Haskell code.

* Update starting guide and redirect gallery links to master branch.

* Include link to readthedocs.


Former-commit-id: 90e846e5001deadd6c921f611c69b3a4210db30d
This commit is contained in:
David Himmelstrup 2019-09-19 16:52:34 +08:00 committed by GitHub
commit 23146429a5
9 changed files with 268 additions and 3 deletions

183
docs/gallery.md Normal file
View file

@ -0,0 +1,183 @@
# Gallery
This file is auto-generated by docs/render_all.sh. DO NOT EDIT.
## boundingbox
<details>
<summary>View boundingbox.hs</summary>
<pre><code class="haskell">
{!examples/boundingbox.hs!}
</code></pre>
</details>
<br/>
<video width="640" height="360" autoplay loop>
<source src="https://github.com/Lemmih/reanimate/raw/master/docs/rendered/boundingbox.mp4">
</video>
<br/><hr><br/>
## colormaps
<details>
<summary>View colormaps.hs</summary>
<pre><code class="haskell">
{!examples/colormaps.hs!}
</code></pre>
</details>
<br/>
<video width="640" height="360" autoplay loop>
<source src="https://github.com/Lemmih/reanimate/raw/master/docs/rendered/colormaps.mp4">
</video>
<br/><hr><br/>
## goo
<details>
<summary>View goo.hs</summary>
<pre><code class="haskell">
{!examples/goo.hs!}
</code></pre>
</details>
<br/>
<video width="640" height="360" autoplay loop>
<source src="https://github.com/Lemmih/reanimate/raw/master/docs/rendered/goo.mp4">
</video>
<br/><hr><br/>
## latex_basic
<details>
<summary>View latex_basic.hs</summary>
<pre><code class="haskell">
{!examples/latex_basic.hs!}
</code></pre>
</details>
<br/>
<video width="640" height="360" autoplay loop>
<source src="https://github.com/Lemmih/reanimate/raw/master/docs/rendered/latex_basic.mp4">
</video>
<br/><hr><br/>
## latex_color
<details>
<summary>View latex_color.hs</summary>
<pre><code class="haskell">
{!examples/latex_color.hs!}
</code></pre>
</details>
<br/>
<video width="640" height="360" autoplay loop>
<source src="https://github.com/Lemmih/reanimate/raw/master/docs/rendered/latex_color.mp4">
</video>
<br/><hr><br/>
## latex_draw
<details>
<summary>View latex_draw.hs</summary>
<pre><code class="haskell">
{!examples/latex_draw.hs!}
</code></pre>
</details>
<br/>
<video width="640" height="360" autoplay loop>
<source src="https://github.com/Lemmih/reanimate/raw/master/docs/rendered/latex_draw.mp4">
</video>
<br/><hr><br/>
## latex_wheel
<details>
<summary>View latex_wheel.hs</summary>
<pre><code class="haskell">
{!examples/latex_wheel.hs!}
</code></pre>
</details>
<br/>
<video width="640" height="360" autoplay loop>
<source src="https://github.com/Lemmih/reanimate/raw/master/docs/rendered/latex_wheel.mp4">
</video>
<br/><hr><br/>
## raster
<details>
<summary>View raster.hs</summary>
<pre><code class="haskell">
{!examples/raster.hs!}
</code></pre>
</details>
<br/>
<video width="640" height="360" autoplay loop>
<source src="https://github.com/Lemmih/reanimate/raw/master/docs/rendered/raster.mp4">
</video>
<br/><hr><br/>
## sphere
<details>
<summary>View sphere.hs</summary>
<pre><code class="haskell">
{!examples/sphere.hs!}
</code></pre>
</details>
<br/>
<video width="640" height="360" autoplay loop>
<source src="https://github.com/Lemmih/reanimate/raw/master/docs/rendered/sphere.mp4">
</video>
<br/><hr><br/>
## sunflower
<details>
<summary>View sunflower.hs</summary>
<pre><code class="haskell">
{!examples/sunflower.hs!}
</code></pre>
</details>
<br/>
<video width="640" height="360" autoplay loop>
<source src="https://github.com/Lemmih/reanimate/raw/master/docs/rendered/sunflower.mp4">
</video>
<br/><hr><br/>
## tangent_and_normal
<details>
<summary>View tangent_and_normal.hs</summary>
<pre><code class="haskell">
{!examples/tangent_and_normal.hs!}
</code></pre>
</details>
<br/>
<video width="640" height="360" autoplay loop>
<source src="https://github.com/Lemmih/reanimate/raw/master/docs/rendered/tangent_and_normal.mp4">
</video>
<br/><hr><br/>
## vector_field
<details>
<summary>View vector_field.hs</summary>
<pre><code class="haskell">
{!examples/vector_field.hs!}
</code></pre>
</details>
<br/>
<video width="640" height="360" autoplay loop>
<source src="https://github.com/Lemmih/reanimate/raw/master/docs/rendered/vector_field.mp4">
</video>
<br/><hr><br/>