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
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
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
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
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
