Skip to content

Latest commit

 

History

History
20 lines (12 loc) · 795 Bytes

File metadata and controls

20 lines (12 loc) · 795 Bytes

Check documentation

  1. To build automatic documentation, it is recommended to install the following dependencies:

    pip install .[docs]
  2. Documentation files should be located in the docs/ directory, which must contain the docs/source/conf.py (build settings) and docs/source/index.rst (documentation main page) files.

  3. Build documentation into HTML pages is done as follows:

    python -m sphinx -T -E -W -b html -d docs/_build/doctrees -D language=en docs/source docs/_build