Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
..
Failed to load latest commit information.
build
source
Makefile
README.rst
make.bat

README.rst

Documentation

For generating documentation it's used Sphinx with publishing in Read the Docs.

Installation

Local

Follow instructions to install Sphinx.

Docker

Follow instructions in Docker Readme.

Running

Local

To generate documentation please run commands bellow inside docs directory:

  • to see all supported formats please run: make help
  • to get documentation in html format please run: make html

Note: generated documentation is saved in docs/build directory.

Docker

Information how generate documentation using Spinx inside Docker Readme