-
- -
-

Docs

-

This directory contains the instructions for building static html documentations based on sphinx.

-
-

Build the docs

-

Install the packages required for building documentation:

-
 pip install -r docs/requirements.txt
-
-
-

And then, change directory to docs folder to build the docs.

-
cd docs/
-sphinx-build -M html . build
-
-
-
-
-

Preview the docs locally

-
cd build/html
-python -m http.server
-
-
-

You can visit the page with your web browser with url http://localhost:8080.

-
-
- - -
-