Creating documentation using Sphinx

To modify the content of the documentation, you have to change .rst files or add new ones in docs/source folder.

Some rst syntax hints can be found here:

• A ReStructuredText Primer

• reStructuredText Markup Specification

Building documentation

To build a documentation, follow steps:

cd docs/source
make html

Html files are stored in docs/build/html. To check your build, simply open index.html in your browser.

Generate documentation from docstrings

To generate documentation from docstrings:

sphinx-apidoc -o docs/source ./markupit

Sphinx will generate .rst file for every module in our project.