Commit graph

12 commits

Author SHA1 Message Date
Benjamin Hackl
17a3c637e8
Improve sidebar structure of reference manual (#1778)
* move modules in reference manual around to have nicer sidebar structure

* use short names in page titles and sidebar

* fix broken reference

* remove some autogenerated files that shouldn't be tracked

* include module list in reference.html

Co-authored-by: Darylgolden <darylgolden@gmail.com>
2021-07-19 12:19:21 -04:00
Benjamin Hackl
a75587c209 render full documentation for module level functions 2020-10-31 16:11:08 +01:00
Benjamin Hackl
3c13ceb1db change png to svg 2020-10-21 00:31:13 +02:00
Benjamin Hackl
c9685765f6 newline at end of logo-text.html 2020-10-20 21:03:00 +02:00
Benjamin Hackl
da875bb8e2 add new logo to documentation 2020-10-20 20:27:46 +02:00
Benjamin Hackl
8c68beea1a show class inheritance in documentation 2020-10-12 19:17:31 +02:00
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
Leo Torres
662777bb96
Docs (#347)
* add some module docstrings

* add some breathing room in the generated autosummaries

* edit template so it generates cleaner output

* document add and remove

* document new conf.py option

* updates from code review

Co-authored-by: Pg Biel <9021226+PgBiel@users.noreply.github.com>
Co-authored-by: Aathish Sivasubrahmanian <aathish04@gmail.com>
Co-authored-by: Naveen M K <naveen@syrusdark.website>
2020-08-28 09:20:21 -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
leotrs
7185c77734 use napoleon instead of numpydoc. Also add a new template for class autosummaries 2020-08-14 22:05:03 -04:00
leotrs
02d0cbb995 add the new module template that makes autosummary behave well 2020-08-14 11:05:32 -04:00