mirror of
https://github.com/ManimCommunity/manim.git
synced 2026-06-22 10:01:47 +00:00
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:
parent
bebefaf48a
commit
aada9f00f0
12 changed files with 26 additions and 25 deletions
1
.gitignore
vendored
1
.gitignore
vendored
|
|
@ -57,6 +57,7 @@ coverage.xml
|
|||
docs/_build/
|
||||
docs/build/
|
||||
docs/source/_autosummary/
|
||||
docs/source/reference/
|
||||
|
||||
# PyBuilder
|
||||
target/
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ Examples
|
|||
.. toctree::
|
||||
:caption: Table of Contents
|
||||
|
||||
hello_example
|
||||
examples/hello_example
|
||||
|
|
@ -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
|
||||
|
|
|
|||
10
docs/source/installation.rst
Normal file
10
docs/source/installation.rst
Normal file
|
|
@ -0,0 +1,10 @@
|
|||
Installation
|
||||
============
|
||||
|
||||
.. toctree::
|
||||
:caption: Table of Contents
|
||||
|
||||
installation/win
|
||||
installation/ubuntu
|
||||
installation/arch
|
||||
installation/mac
|
||||
|
|
@ -1,10 +0,0 @@
|
|||
Installation
|
||||
============
|
||||
|
||||
.. toctree::
|
||||
:caption: Table of Contents
|
||||
|
||||
installation_win
|
||||
installation_ubuntu
|
||||
installation_arch
|
||||
installation_mac
|
||||
|
|
@ -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
|
||||
|
|
|
|||
9
docs/source/tutorials.rst
Normal file
9
docs/source/tutorials.rst
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
Tutorials
|
||||
============
|
||||
|
||||
.. toctree::
|
||||
:caption: Table of Contents
|
||||
|
||||
tutorials/quickstart
|
||||
tutorials/a_deeper_look
|
||||
tutorials/configuration
|
||||
|
|
@ -1,9 +0,0 @@
|
|||
Tutorials
|
||||
============
|
||||
|
||||
.. toctree::
|
||||
:caption: Table of Contents
|
||||
|
||||
quickstart
|
||||
a_deeper_look
|
||||
configuration
|
||||
Loading…
Add table
Add a link
Reference in a new issue