The documentation is written in reStructuredText format and can be build with Sphinx documentation generator.

It is recommended to install Python dependencies in virtual environment.

$ python3 -m venv .venv
$ source .venv/bin/activate
(.venv) $ pip3 install -r requirements.txt

When finished working inside the virtual environment you can step out of it:

(.venv) $ deactivate

To build the project you need to be in the virtual environment.

(.venv) $ make html

Some changes may require a full project rebuild as documents are usually linked to each other:

(.venv) $ make clean && make html

$ firefox _build/html/index.html

You do not need to be in virtual environment to see the build result.

There is a sample page that can get you started with reStructuredText. You can view it after the build is finished with:

$ firefox _build/html/example.html

An alternative is to use live lookup tools like online reStructuredText editor.

1. Create a new page in reStructuredText format and include in somewhere in src folder.
2. Every new page needs to be part of a page table of content (ToC) tree. To add a page to the ToC tree, either include it in toc directive in an existing document or add it to the top level navigation in the contents document.
3. Build the documentation with make html and navigation to your page to check that everything display as intended.
4. Open a Pull Request against this repository with your change.