Skip to content

armgit / manim

Public Imported from GitHub
0

A community-maintained Python framework for creating mathematical animations.

some changes to prettify the docs output

leotrs5c657ff4dabd
diff --git a/docs/source/_templates/autosummary/class.rst b/docs/source/_templates/autosummary/class.rst
index 827c0b0e1..79c5dd365 100644
--- a/docs/source/_templates/autosummary/class.rst
+++ b/docs/source/_templates/autosummary/class.rst
@@ -11,8 +11,8 @@
.. autosummary::
:nosignatures:
:toctree: .
- {% for item in methods %}
- ~{{ name }}.{{ item }}
+ {% for item in methods if item != '__init__' %}
+ ~{{ name }}.{{ item }}
{%- endfor %}
{% endif %}
{% endblock %}
diff --git a/docs/source/_templates/autosummary/module.rst b/docs/source/_templates/autosummary/module.rst
index 260a4d4a2..ba44c4759 100644
--- a/docs/source/_templates/autosummary/module.rst
+++ b/docs/source/_templates/autosummary/module.rst
@@ -32,6 +32,7 @@
.. autosummary::
:toctree: .
+ :nosignatures:
{% for class in classes %}
{{ class }}
{% endfor %}
diff --git a/docs/source/reference.rst b/docs/source/reference.rst
index 5b6c6909d..21c206f8a 100644
--- a/docs/source/reference.rst
+++ b/docs/source/reference.rst
@@ -1,11 +1,16 @@
Reference
===============
-This reference manual details functions, modules, and objects included in
+This reference manual details modules, functions, and variables included in
Manim, describing what they are and what they do. For learning how to use
-Manim, see :doc:`tutorials`. For a list of changes since the
-last release, see the :doc:`changelog`.
+Manim, see :doc:`tutorials`. For a list of changes since the last release, see
+the :doc:`changelog`.
+.. warning:: The paged linked to here are currently a work in progress.
+
+
+List of Modules
+***************
.. currentmodule:: manim
@@ -13,7 +18,7 @@ last release, see the :doc:`changelog`.
:toctree: reference
container
- mobject.mobject
+ ~mobject.mobject
config
constants
diff --git a/manim/container.py b/manim/container.py
index 6bec98489..a80c92eb2 100644
--- a/manim/container.py
+++ b/manim/container.py
@@ -10,12 +10,14 @@ __all__ = ["Container"]
class Container(ABC):
- """Abstract base class for several manim objects.
+ """Abstract base class for several objects used by manim. In particular, both
+ :class:`~.Scene` and :class:`~.Mobject` inherit from Container.
Parameters
----------
kwargs : Any
Arguments to be passed to :func:`~.digest_config`
+
"""
def __init__(self, **kwargs):