A community-maintained Python framework for creating mathematical animations.
use the autosummary extension to automatically generate module and class files
leotrsb83193a702db
diff --git a/.gitignore b/.gitignoreindex 364e29921..bbba319d8 100644--- a/.gitignore+++ b/.gitignore@@ -56,6 +56,7 @@ coverage.xml# Sphinx documentationdocs/_build/docs/build/+docs/source/_autosummary/# PyBuildertarget/diff --git a/docs/source/conf.py b/docs/source/conf.pyindex 25d20277a..dcefbbc2d 100644--- a/docs/source/conf.py+++ b/docs/source/conf.py@@ -31,8 +31,11 @@ extensions = ['sphinx.ext.autodoc','sphinx_rtd_theme','recommonmark',+ 'numpydoc',]+autosummary_generate = True+# Add any paths that contain templates here, relative to this directory.templates_path = ['_templates']diff --git a/docs/source/config.rst b/docs/source/config.rstdeleted file mode 100644index 0e6cb75a6..000000000--- a/docs/source/config.rst+++ /dev/null@@ -1,4 +0,0 @@-.. automodule:: manim.config- :members:- :undoc-members:- :show-inheritance:diff --git a/docs/source/constants.rst b/docs/source/constants.rstdeleted file mode 100644index b0fb2c6e8..000000000--- a/docs/source/constants.rst+++ /dev/null@@ -1,7 +0,0 @@-Constants-=========--.. automodule:: manim.constants- :members:- :undoc-members:- :show-inheritance:diff --git a/docs/source/index.rst b/docs/source/index.rstindex 7fb4115f3..bbc313a1c 100644--- a/docs/source/index.rst+++ b/docs/source/index.rst@@ -17,7 +17,7 @@ information here will make it easier for newcomers to get started using.. toctree::- :maxdepth: 2+ :maxdepth: 1:caption: Documentationquickstartdiff --git a/docs/source/mobject.rst b/docs/source/mobject.rstdeleted file mode 100644index c798c363f..000000000--- a/docs/source/mobject.rst+++ /dev/null@@ -1,16 +0,0 @@-MObject-=======--The MObject is Manim's main python class representing objects that will be-rendered on screen.---.. automodule:: manim.mobject.mobject- :members:- :undoc-members:- :show-inheritance:--.. automodule:: manim.mobject.geometry- :members:- :undoc-members:- :show-inheritance:diff --git a/docs/source/reference.rst b/docs/source/reference.rstindex 5bde2c4d6..0c9690c1d 100644--- a/docs/source/reference.rst+++ b/docs/source/reference.rst@@ -3,12 +3,15 @@ Manim ReferenceThis reference manual details functions, modules, and objects included inManim, describing what they are and what they do. For learning how to use-Manim, see the quickstart and tutorial documents.+Manim, see the :doc:`quickstart` and :doc:`tutorial` documents.-.. toctree::- :maxdepth: 0+.. currentmodule:: manim- mobject+.. autosummary::+ :toctree: _autosummary++ container.container+ mobject.mobjectconfigconstantsdiff --git a/docs/source/tutorial.md b/docs/source/tutorial.mdindex 9105bef81..fdfedfed9 100644--- a/docs/source/tutorial.md+++ b/docs/source/tutorial.md@@ -1,3 +1,5 @@+# Tutorial+[NOTE:] this is some text I wrote that was originally meant to be part of thequickstart. However, after some thought I've decided that it's probably a bittoo much for the quickstart, as the quickstart document is supposed to showcase