mirror of
https://github.com/jeertmans/manim-slides.git
synced 2025-07-15 00:52:15 +08:00
7ba47728ff
* chore(docs): document HTML custom templates Shows an example of custom template. TODO: - [ ] finish documentating; - [ ] add possibility to pass `-cargs` to Manim Slides' `convert` method when calling the Sphinx extension. Closes #356 * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * chore(docs): document changes and fix --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
39 lines
1012 B
Markdown
39 lines
1012 B
Markdown
# Reference Documentation
|
|
|
|
Automatically generated reference for Manim Slides.
|
|
|
|
```{toctree}
|
|
:hidden:
|
|
|
|
api
|
|
cli
|
|
customize_html
|
|
examples
|
|
gui
|
|
html
|
|
IPython magic <ipython_magic>
|
|
sharing
|
|
Sphinx Extension <sphinx_extension>
|
|
```
|
|
|
|
[Application Programming Interface](./api): list of classes and methods that may
|
|
be useful to the end-user.
|
|
|
|
[Command Line Interface](./cli): list of all commands available using Manim
|
|
Slides' executable.
|
|
|
|
[Examples](./examples): curated list of examples and their output.
|
|
|
|
[Graphical User Interface](./gui): details about the main Manim Slide' feature.
|
|
|
|
[HTML Presentation](./html): an alternative way of presenting your animations.
|
|
|
|
[IPython Magic](./ipython_magic): a magic to render and display Manim Slides inside notebooks.
|
|
|
|
+ [Example](./magic_example): example notebook using the magics.
|
|
|
|
[Sharing](./sharing): how to share your presentation with others.
|
|
|
|
|
|
[Sphinx Extension](./sphinx_extension): a Sphinx extension for diplaying Manim Slides animations within your documentation.
|