Commit graph

14 commits

Author SHA1 Message Date
Benjamin Hackl
5467978110
Improve/extend reference manual (#438)
* include _all_ modules in reference manual

* improve table of contents in sidebar

* modify class template: no longer use separate files for all methods

* no signatures in table overview

* rewrite code_mobject module docstring

* add one-line module docstrings

* rudimentary documentation of changing.py

* add example to ValueTracker

* clarify that Text does not use LaTeX

Co-authored-by: Leo Torres <dleonardotn@gmail.com>
Co-authored-by: Hugues Devimeux <36239975+huguesdevimeux@users.noreply.github.com>
2020-09-16 11:08:07 -04:00
leotrs
2c94a5c792 Make it so that the config module is reachable, as _config. This is used e.g. in the docs. This also fixes an image path in docs/source/contributing.md. 2020-08-24 08:27:32 -04:00
leotrs
cf66a22a4c add some other modules to the API reference 2020-08-21 22:34:26 -04:00
leotrs
5c657ff4da some changes to prettify the docs output 2020-08-21 22:01:25 -04:00
Leo Torres
271c235f78
Documentation: finish quickstart and add installation instructions (#324)
* add output of manim -h to the documentation, as a poor man documentation of CLI arguments

* document config system and general changes in the description of each command line flag

* run black

* MacOS

* update

* Add configuration.rst back to the toctree. Add the contributing guidelines, which is just a symlink to the main repository\'s contributing.md file.

* add the symlinks

* fix length of underlines

* update contributing guidelines

* convert quickstart doc from md to rst. Also add a troubleshooting stub file

* finish the second part of the quickstart

* add general and linux instructions

* add mac instructions

* add windows install instructions

* final touches

* Update docs/source/installation/win.rst

Co-authored-by: Naveen M K <naveen@syrusdark.website>

* Update a_deeper_look.rst

added explanation on the  ``-s`` flag

* Update docs/source/installation/installation_linux.rst

Co-authored-by: Aathish Sivasubrahmanian <aathish04@gmail.com>

* Update docs/source/installation/win.rst

Co-authored-by: Aathish Sivasubrahmanian <aathish04@gmail.com>

* Update docs/source/installation/win.rst

Co-authored-by: Aathish Sivasubrahmanian <aathish04@gmail.com>

* Update docs/source/installation/win.rst

Co-authored-by: Aathish Sivasubrahmanian <aathish04@gmail.com>

* Update docs/source/installation/win.rst

Co-authored-by: Aathish Sivasubrahmanian <aathish04@gmail.com>

* updates from code review

* update from code review

Co-authored-by: Pg Biel <9021226+PgBiel@users.noreply.github.com>
Co-authored-by: Naveen M K <naveen@syrusdark.website>
Co-authored-by: kolibril13 <44469195+kolibril13@users.noreply.github.com>
Co-authored-by: Aathish Sivasubrahmanian <aathish04@gmail.com>
2020-08-21 20:40:27 -04:00
Leo Torres
aada9f00f0
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) 2020-08-17 07:43:52 -04:00
Leo Torres
54854ccf23
Documenting the config system (#303)
* add output of manim -h to the documentation, as a poor man documentation of CLI arguments

* document config system and general changes in the description of each command line flag

* run black

* MacOS

* update

* Add configuration.rst back to the toctree. Add the contributing guidelines, which is just a symlink to the main repository\'s contributing.md file.

* add the symlinks

* fix length of underlines

Co-authored-by: Pg Biel <9021226+PgBiel@users.noreply.github.com>
2020-08-16 07:08:26 -04:00
Leo Torres
dc5abe3917
Merge pull request #297 from ManimCommunity/organize_sphinx_chapters
# Docs-Chapters rearranged
2020-08-15 22:04:46 -04:00
kolibril13
68046dfbe0 # fixed typos 2020-08-15 19:59:54 +02:00
leotrs
db354ff9b9 update docs 2020-08-15 13:18:48 -04:00
kolibril13
2752a47279 added changelog an gifs 2020-08-15 15:31:56 +02:00
kolibril13
ba418692f9 # Restructured the docs-chapters 2020-08-15 12:57:38 +02:00
leotrs
b83193a702 use the autosummary extension to automatically generate module and class files 2020-08-14 11:04:58 -04:00
leotrs
94f004d5f6 initial sphinx setup 2020-08-04 14:51:16 -04:00