Commit graph

22 commits

Author SHA1 Message Date
Benjamin Hackl
9a39701f79
More color changes (#706)
* change "primary color" from green to blue

* change color of several admonition blocks to our logo palette
2020-11-14 11:52:28 -05:00
Safin Singh
6addeccadf
Clean up README (#586)
* Clean up README

* update flags

* Apply suggestions from code review

* updated command.png

* removed redundant files from readme-asserts and used files from docs/_static instead

* change to relative parts

Co-authored-by: Leo Torres <leo@leotrs.com>
Co-authored-by: kolibril13 <jan-hendrik.mueller@gmx.net>
2020-11-10 13:28:50 +01:00
Benjamin Hackl
912ab0ec54
Anchors for example blocks in documentation (#658)
* add anchors to example blocks

* fix save_as_gif in manim_directive
2020-11-01 14:04:49 +05:30
Benjamin Hackl
1d56066af4 change colors of "see also" blocks 2020-10-31 16:43:05 +01:00
Benjamin Hackl
4e8680edb8 custom styling for module-level functions 2020-10-31 16:12:00 +01:00
Naveen M K
c6b4c1ea4a
Add a favicon 2020-10-29 13:56:21 +05:30
Benjamin Hackl
1d863e469d
Improve design of documentation (#617)
* redesign documentation \o/

* outline 0 for videos

* forgot border-color for source blocks

* adapt styling for example references

* change link and text color

* suggestion for new order of top-level docs

* mathematical objects --> mobjects
2020-10-27 19:54:03 +01:00
Benjamin Hackl
1a6b0c269d
Custom "Example reference"-blocks for examples with manim directive (#607)
* add seealso options to manim directive

* illustrate use of seealso_classes

* remove unneeded import

* rename: seealso -> ref

* custom styling

* change to ref_classes in example
2020-10-24 23:01:36 +02:00
Benjamin Hackl
3c13ceb1db change png to svg 2020-10-21 00:31:13 +02:00
Benjamin Hackl
da875bb8e2 add new logo to documentation 2020-10-20 20:27:46 +02:00
nilaybhatia
2ef6194415 Add an image of non-standard rate funcs to docs 2020-10-06 23:50:58 +05:30
Naveen M K
ec059ccf29
Align Images in Mobile - Sphinx (#440) 2020-09-13 08:30:36 -04:00
Benjamin Hackl
e6e8cd94da
delete static files (#436) 2020-09-12 15:44:06 -04:00
Leo Torres
e48d46717b
New tutorial: manim internals basic (#394)
* add a section to the quickstart explaining the basics of building a scene

* add the internals_basic tutorial. Currently contains the section for Mobjects only

Co-authored by @behackl

Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>
2020-09-12 11:51:12 -04:00
Benjamin Hackl
9c511502cc
Render videos while building documentation (#402)
Implement a sphinx directive to allow for rendering video at the time of generating the documentation
2020-09-11 16:22:06 -04:00
Benjamin Hackl
d470a8d92a
Fix overflowing images in documentation (#392)
* add width and some margin-bottom to img.align-center, change spacing
2020-08-31 14:49:12 -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
46fa54e565 symlinks dont work on windows 2020-08-22 13:18:10 -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
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
e1f97335b9 1: make sphinx accept markdown files. 2: add a changelog stub file. 3: add a sample quickstart text that shows how to include .gif files. 2020-08-10 14:48:48 -04:00