A community-maintained Python framework for creating mathematical animations.
Change the folder of auto-generated reference from _autosummary to reference. This will change the URLs as well so they look prettier. I also moved the installation/examples/tutorials indices one folder up so the URLs look less messy and more straightforward as well. (#312)
Leo Torresaada9f00f055
diff --git a/.gitignore b/.gitignoreindex bbba319d8..f7da3fa52 100644--- a/.gitignore+++ b/.gitignore@@ -57,6 +57,7 @@ coverage.xmldocs/_build/docs/build/docs/source/_autosummary/+docs/source/reference/# PyBuildertarget/diff --git a/docs/source/examples/examples_index.rst b/docs/source/examples.rstsimilarity index 72%rename from docs/source/examples/examples_index.rstrename to docs/source/examples.rstindex 7e40fcd9b..1c9822660 100644--- a/docs/source/examples/examples_index.rst+++ b/docs/source/examples.rst@@ -4,4 +4,4 @@ Examples.. toctree:::caption: Table of Contents- hello_example\ No newline at end of file+ examples/hello_examplediff --git a/docs/source/index.rst b/docs/source/index.rstindex 59ace2122..cadc32677 100644--- a/docs/source/index.rst+++ b/docs/source/index.rst@@ -20,10 +20,10 @@ information here will make it easier for newcomers to get started using:maxdepth: 2:caption: Documentation- installation/installation_index+ installationreference- examples/examples_index- tutorials/tutorials_index+ examples+ tutorialscontributingNavigationdiff --git a/docs/source/installation.rst b/docs/source/installation.rstnew file mode 100644index 000000000..e94c91660--- /dev/null+++ b/docs/source/installation.rst@@ -0,0 +1,10 @@+Installation+============++.. toctree::+ :caption: Table of Contents++ installation/win+ installation/ubuntu+ installation/arch+ installation/macdiff --git a/docs/source/installation/installation_arch.rst b/docs/source/installation/arch.rstsimilarity index 100%rename from docs/source/installation/installation_arch.rstrename to docs/source/installation/arch.rstdiff --git a/docs/source/installation/installation_index.rst b/docs/source/installation/installation_index.rstdeleted file mode 100644index f0497a9ed..000000000--- a/docs/source/installation/installation_index.rst+++ /dev/null@@ -1,10 +0,0 @@-Installation-============--.. toctree::- :caption: Table of Contents-- installation_win- installation_ubuntu- installation_arch- installation_mac\ No newline at end of filediff --git a/docs/source/installation/installation_mac.rst b/docs/source/installation/mac.rstsimilarity index 100%rename from docs/source/installation/installation_mac.rstrename to docs/source/installation/mac.rstdiff --git a/docs/source/installation/installation_ubuntu.rst b/docs/source/installation/ubuntu.rstsimilarity index 100%rename from docs/source/installation/installation_ubuntu.rstrename to docs/source/installation/ubuntu.rstdiff --git a/docs/source/installation/installation_win.rst b/docs/source/installation/win.rstsimilarity index 100%rename from docs/source/installation/installation_win.rstrename to docs/source/installation/win.rstdiff --git a/docs/source/reference.rst b/docs/source/reference.rstindex 5efaa821a..79425b7fc 100644--- a/docs/source/reference.rst+++ b/docs/source/reference.rst@@ -3,14 +3,14 @@ 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 :doc:`tutorials/tutorials_index`. For a list of changes since the+Manim, see :doc:`tutorials`. For a list of changes since thelast release, see the :doc:`changelog`... currentmodule:: manim.. autosummary::- :toctree: _autosummary+ :toctree: referencecontainermobject.mobjectdiff --git a/docs/source/tutorials.rst b/docs/source/tutorials.rstnew file mode 100644index 000000000..2f1393b59--- /dev/null+++ b/docs/source/tutorials.rst@@ -0,0 +1,9 @@+Tutorials+============++.. toctree::+ :caption: Table of Contents++ tutorials/quickstart+ tutorials/a_deeper_look+ tutorials/configurationdiff --git a/docs/source/tutorials/tutorials_index.rst b/docs/source/tutorials/tutorials_index.rstdeleted file mode 100644index fe3f80dda..000000000--- a/docs/source/tutorials/tutorials_index.rst+++ /dev/null@@ -1,9 +0,0 @@-Tutorials-============--.. toctree::- :caption: Table of Contents-- quickstart- a_deeper_look- configuration