Skip to content

Latest commit

 

History

History

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 

Step 1. Create API docs!

Read more here: https://www.sphinx-doc.org/en/master/man/sphinx-apidoc.html and here: https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html

$ cd docs
$ make clean
$ make rst
$ make html

Step 2. View edits and make changes accordingly.

http://localhost:63342/Projects/quantus/docs/build/html/index.html

A copy is made of CONTRIBUTING.md to docs_dev/CONTRIBUTING.md. To avoid any inconsistencies, edit in CONTRIBUTING.md and overwrite in docs_dev/CONTRIBUTING.md.