Commit graph

16 commits

Author SHA1 Message Date
Nikhil Garuda
1746073b8c
Added entry for typestring parser check tool (#1402)
* Added typestring parser checker

* Updated some errors

* Update

* Checking if installation wokrs

* Trying again

* Updates

* Another Update

* Update pyproject.toml

* Update documentation.rst

* Update requirements.txt

* Update

* syntax highlighting should work?

* Update

* Reverted back

* Will this work?

* Update

* Still trying

* Update

* Update again

* Fixed the indentation issues

* Update

* updated code block

* Update again

* Update

* Update again with blackendocs

* Update documentation.rst

* Added skip option to doctests

* Added the link

* Update link
2021-05-06 22:26:10 -07:00
Anton Ballmaier
2d2604bca9
Add inheritance diagrams to reference page (#1441)
* test

* revert test changes

* add inheritance map

* Configure Graph to fit dark theme

* Add inheritance graphs to each section in reference

* Responsive color scheme

* remove unnecessary comment

* remove more stuff from testing

* and more still

* Update docs/source/_static/responsiveSvg.js

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

* Add graphviz explanation to docs

* add background color fix for chrome

* Add subheadings

* Chnaged Headings to singular and bold

Apply suggestions from code review

Co-authored-by: Jan-Hendrik Müller <44469195+kolibril13@users.noreply.github.com>

Co-authored-by: Naveen M K <naveen@syrusdark.website>
Co-authored-by: Jan-Hendrik Müller <44469195+kolibril13@users.noreply.github.com>
2021-05-06 12:31:02 +02:00
Skaft
bbe113e7d3
Fixing broken doc links (#1457)
* fix broken links

* fix typo
2021-05-03 21:13:51 +05:30
Nikhil Garuda
fccce24a9b
Added Guide to Contribute Examples from GitHub Wiki to Documentation (#1387)
* Changed prepare_animation example

* Update animation.py

* Changed prepare_animation example

* Update animation.py

* Update animation.py

* Reverted

* Add Guide to Contribute Examples

* Update

* Rewrote some of the guide

Updated issues with docs rendering improperly.
Fixed some grammar.
Perhaps broke some things

* Update docs/source/contributing/documentation.rst

Co-authored-by: kolibril13 <44469195+kolibril13@users.noreply.github.com>

* Update documentation.rst

* Update

* Update docs/source/contributing/documentation.rst

Co-authored-by: kolibril13 <44469195+kolibril13@users.noreply.github.com>

* Trigger Build

* Updated

* Build pls work

* Update

* Update docs/source/contributing/documentation.rst

Co-authored-by: Jason Villanueva <a@jsonvillanueva.com>

* Update docs/source/contributing/documentation.rst

Co-authored-by: Jason Villanueva <a@jsonvillanueva.com>

* Update docs/source/contributing/documentation.rst

Co-authored-by: Jason Villanueva <a@jsonvillanueva.com>

* Apply suggestions from code review

Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>

* updated note tab

Co-authored-by: Jason Villanueva <a@jsonvillanueva.com>
Co-authored-by: kolibril13 <44469195+kolibril13@users.noreply.github.com>
Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>
2021-04-30 21:59:56 +02:00
Benjamin Hackl
7f17ea6d24
Fixed all current docbuild warnings (#1424)
* fix all current docbuild warnings

* Rerun rtd

Co-authored-by: Jason Villanueva <a@jsonvillanueva.com>
2021-04-29 19:04:08 -07:00
kolibril13
cf8ae0811e
Add admonitions tutorial to docs (#1389)
* more docs

* more docs

* refining

* comma fix

* refine further

* typo

* typo

* refine

* Update docs/source/contributing/documentation.rst

Co-authored-by: Jason Villanueva <a@jsonvillanueva.com>

* Update docs/source/contributing/documentation.rst

Co-authored-by: Jason Villanueva <a@jsonvillanueva.com>

* applied suggestions

Co-authored-by: Jason Villanueva <a@jsonvillanueva.com>
2021-04-28 21:03:11 -07:00
Nikhil Garuda
80a1bfcd2f
Add flake8 and isort in docs (#1376)
* Grammatical error correction of docs

* Update contributing.rst

* Update development.rst

* Update development.rst

* Update development.rst

* Update for_dev.rst

* Update docs/source/installation/for_dev.rst

Co-authored-by: Darylgolden <darylgolden@gmail.com>

* Update plugins.rst

* Update reporting_bugs.rst

* Update a_deeper_look.rst

* Update configuration.rst

* Update quickstart.rst

* Update building_blocks.rst

* Update testing.rst

* Update testing.rst

* Update versions.rst

* Update a_deeper_look.rst

* Update quickstart.rst

* Update quickstart.rst

* Update development.rst

* Update development.rst

* Update versions.rst

* Update versions.rst

* Update a_deeper_look.rst

* Update building_blocks.rst

* Change of complier and output format in
 "InCodeTexTemplate" to the defaults

* Reverted back

* Change of Complier and Output format

The Complier and Output format of class InCodeTexTemplate has been changed to the defaults (latex and .dvi)

* Update customtex.py

* Update building_blocks.rst

* Update building_blocks.rst

* Update a_deeper_look.rst

* Updated Code Style to include isort and flake8

* Update

* Update

* Delete test.py

* Update development.rst

* Update development.rst

* Update development.rst

* Update development.rst

* Update docs/source/contributing/development.rst

Co-authored-by: kolibril13 <44469195+kolibril13@users.noreply.github.com>

* Update development.rst

Co-authored-by: Darylgolden <darylgolden@gmail.com>
Co-authored-by: kilacoda <65204531+kilacoda@users.noreply.github.com>
Co-authored-by: kolibril13 <44469195+kolibril13@users.noreply.github.com>
2021-04-21 17:50:51 -07:00
Nikhil Garuda
7c8c1cb1d9
Grammatical error corrections in documentation (#1360)
* Grammatical error correction of docs

* Update contributing.rst

* Update development.rst

* Update development.rst

* Update development.rst

* Update for_dev.rst

* Update docs/source/installation/for_dev.rst

Co-authored-by: Darylgolden <darylgolden@gmail.com>

* Update plugins.rst

* Update reporting_bugs.rst

* Update a_deeper_look.rst

* Update configuration.rst

* Update quickstart.rst

* Update building_blocks.rst

* Update testing.rst

* Update testing.rst

* Update versions.rst

* Update a_deeper_look.rst

* Update quickstart.rst

* Update quickstart.rst

* Update development.rst

* Update development.rst

* Update versions.rst

* Update versions.rst

* Update a_deeper_look.rst

* Update building_blocks.rst

* Change of complier and output format in
 "InCodeTexTemplate" to the defaults

* Reverted back

* Change of Complier and Output format

The Complier and Output format of class InCodeTexTemplate has been changed to the defaults (latex and .dvi)

* Update customtex.py

* Update building_blocks.rst

* Update building_blocks.rst

* Update a_deeper_look.rst

Co-authored-by: Darylgolden <darylgolden@gmail.com>
Co-authored-by: kilacoda <65204531+kilacoda@users.noreply.github.com>
Co-authored-by: Jason Villanueva <a@jsonvillanueva.com>
2021-04-19 15:44:32 -07:00
Nikhil Garuda
f8beaa4ba2
Changed the format (#1358) 2021-04-18 10:20:47 +02:00
kolibril13
642b7683b2
Added documentation guidelines for type hints (#1338)
* added guidlines for typehints

* added lines

* Apply suggestions from code review

Co-authored-by: Darylgolden <darylgolden@gmail.com>

* Update documentation.rst

* Update documentation.rst

* Update documentation.rst

* added ``None`` typehint

* added Optional

* Update documentation.rst

* Update documentation.rst

* Update documentation.rst

* Update documentation.rst

* Update documentation.rst

* Update documentation.rst

* blacken-docs

* Update docs/source/contributing/documentation.rst

* Update documentation.rst

Co-authored-by: Darylgolden <darylgolden@gmail.com>
Co-authored-by: Jason Villanueva <a@jsonvillanueva.com>
2021-04-16 21:01:21 -07:00
Naveen M K
7417fbc599
Blacken docs (#1323)
this hook will check formats in docs code blocks and format it using black
2021-04-13 11:57:27 +05:30
Aron
053e40060d
Remove Carriage Return (#1281)
Co-authored-by: Aron Fischer <cobordism@github, co-bordism@gitlab>
Co-authored-by: Naveen M K <naveen@syrusdark.website>
2021-04-07 15:22:50 -07:00
Jason Villanueva
5b2d5c3f8b
Added sphinx requirements to pyproject.toml (#1279)
* Added Sphinx dependencies to pyproject.toml

* Updated documentation

* Updates poetry.lock

Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>
2021-04-07 21:58:38 +02:00
Jason Villanueva
1e049d8bd2
Fixed flake8 errors and removed linter/formatter workflows (#1278)
* Fixed flake8 in files outside of manim/manim

* Removed linter/formatter workflows

* Small update to pre-commit in contributing guideline

* Better English/grammar in doc
2021-04-07 06:14:14 -07:00
Darylgolden
9c96d16db1
Copyedited the document on testing in our documentation (#1217)
* Copyediting testing.rst

* More copyediting

* Clarifications on how to generate control test data

* More copyediting

* removed one whitespace

* More fixes

* Minor fix

Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>
Co-authored-by: Jason Villanueva <a@jsonvillanueva.com>
2021-04-01 22:27:12 -07:00
Jason Villanueva
e384ce93f2
Added testing/documentation from GitHub Wiki to Sphinx Docs (#1137)
* Added precommit for black, updated contributing documentation

Updated contributing.rst and related files

Fixed some grammar, added pre-commit section

* picked pre-commit version, removed redundant language_version

* Fix section headings

* Added GitHub testing/doc Wiki pages to docs

* Update docs/source/contributing.rst

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

* Update docs/source/contributing.rst

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

* Update docs/source/contributing.rst

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

* Update docs/source/contributing.rst

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

* Update docs/source/contributing.rst

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

* Update docs/source/contributing.rst

* Update docs/source/contributing.rst

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

* Fixed some relative links

* Fixed flake8 issue

* Apply suggestions from code review

Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>

Co-authored-by: Naveen M K <naveen@syrusdark.website>
Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>
2021-03-31 02:23:38 -07:00