mirror of
https://github.com/jeertmans/manim-slides.git
synced 2025-05-21 12:37:00 +08:00
540c7034c8
This PR adds a new Sphinx directive, inspired by the Manim one. This directive is also used within the docs to display examples.
30 lines
680 B
Markdown
30 lines
680 B
Markdown
# Reference Documentation
|
|
|
|
Automatically generated reference for Manim Slides.
|
|
|
|
```{toctree}
|
|
:hidden:
|
|
|
|
api
|
|
cli
|
|
examples
|
|
gui
|
|
html
|
|
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 Presenetation](./html): an alternative way of presenting your animations.
|
|
|
|
[Sharing](./sharing): how to share your presentation with others.
|