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)

This commit is contained in:
Leo Torres 2020-08-17 07:43:52 -04:00 committed by GitHub
commit aada9f00f0
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
12 changed files with 26 additions and 25 deletions

1
.gitignore vendored
View file

@ -57,6 +57,7 @@ coverage.xml
docs/_build/
docs/build/
docs/source/_autosummary/
docs/source/reference/
# PyBuilder
target/

View file

@ -4,4 +4,4 @@ Examples
.. toctree::
:caption: Table of Contents
hello_example
examples/hello_example

View file

@ -20,10 +20,10 @@ information here will make it easier for newcomers to get started using
:maxdepth: 2
:caption: Documentation
installation/installation_index
installation
reference
examples/examples_index
tutorials/tutorials_index
examples
tutorials
contributing
Navigation

View file

@ -0,0 +1,10 @@
Installation
============
.. toctree::
:caption: Table of Contents
installation/win
installation/ubuntu
installation/arch
installation/mac

View file

@ -1,10 +0,0 @@
Installation
============
.. toctree::
:caption: Table of Contents
installation_win
installation_ubuntu
installation_arch
installation_mac

View file

@ -3,14 +3,14 @@ Reference
This reference manual details functions, modules, and objects included in
Manim, 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 the
last release, see the :doc:`changelog`.
.. currentmodule:: manim
.. autosummary::
:toctree: _autosummary
:toctree: reference
container
mobject.mobject

View file

@ -0,0 +1,9 @@
Tutorials
============
.. toctree::
:caption: Table of Contents
tutorials/quickstart
tutorials/a_deeper_look
tutorials/configuration

View file

@ -1,9 +0,0 @@
Tutorials
============
.. toctree::
:caption: Table of Contents
quickstart
a_deeper_look
configuration