Skip to content

Latest commit

 

History

History
13 lines (11 loc) · 525 Bytes

README.md

File metadata and controls

13 lines (11 loc) · 525 Bytes

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.