opensource/manim-slides
1
0
Fork 0
mirror of https://github.com/jeertmans/manim-slides.git synced 2025-06-01 23:45:15 +08:00
Code Issues Packages Projects Releases Wiki Activity

chore(docs): improving the docs (#115)

Browse Source 
* chore(docs): improving the docs

This improves the docs as suggested by some reddit user. Now, most of Manim is documented in one place

* try: update lockfile

* chore(deps): remove duplicate key

* fix(ci): isort issue

See https://github.com/home-assistant/core/issues/86892

* fix(ci): bad identation

* fix(ci): fixing lock file

* fix(example): issue when ManimGL does not count wait as animation
This commit is contained in:
Jérome Eertmans
2023-01-30 22:23:53 +01:00
committed by GitHub
parent 68ff5269eb
commit 0ce4c18519
22 changed files with 509 additions and 70 deletions
Download Patch File Download Diff File Expand all files Collapse all files

59
docs/source/reference/examples.md Normal file
View File

@ -0,0 +1,59 @@
# Examples
Contents of `example.py`.
Do not forget to import Manim Slides and Manim or ManimGL.
## Basic Example
Basic example from quickstart.
```{eval-rst}
.. literalinclude:: ../../../example.py
:language: python
:linenos:
:pyobject: BasicExample
```
<div style="position:relative;padding-bottom:56.25%;"> <iframe style="width:100%;height:100%;position:absolute;left:0px;top:0px;" frameborder="0" width="100%" height="100%" allowfullscreen allow="autoplay" src="../_static/basic_example.html"></iframe></div>
## 3D Example
Example using 3D camera. As Manim and ManimGL handle 3D differently, definitions are slightly different.
### With Manim
```{eval-rst}
.. literalinclude:: ../../../example.py
:language: python
:linenos:
:dedent: 4
:start-after: [manim-3d]
:end-before: [manim-3d]
```
<div style="position:relative;padding-bottom:56.25%;"> <iframe style="width:100%;height:100%;position:absolute;left:0px;top:0px;" frameborder="0" width="100%" height="100%" allowfullscreen allow="autoplay" src="../_static/three_d_example.html"></iframe></div>
### With ManimGL
```{eval-rst}
.. literalinclude:: ../../../example.py
:language: python
:linenos:
:dedent: 4
:start-after: [manimgl-3d]
:end-before: [manimgl-3d]
```
## Advanced Example
A more advanced example is `ConvertExample`, which is used as demo slide and tutorial.
```{eval-rst}
.. literalinclude:: ../../../example.py
:language: python
:linenos:
:pyobject: ConvertExample
```
<div style="position:relative;padding-bottom:56.25%;"> <iframe style="width:100%;height:100%;position:absolute;left:0px;top:0px;" frameborder="0" width="100%" height="100%" allowfullscreen allow="autoplay" src="../_static/slides.html"></iframe></div>