Build and view documentation¶

Building documentation locally¶

Before building the documentation, make sure you have make installed, since it’s required to build the document:

sudo apt install -y make

To build the documentation, first go to the project directory and activate the development environment:

cd pqwidget
conda activate ciermag-develop

Then, you can compile it using the following command:

tox -e doc

The compiled docs will be available at the ./build/docs/ directory. If you want the HTML version, it is available at the ./build/docs/html directory.

View doumentation locally¶

Viewing the plain HTML on web browser¶

You can view the HTML version of the documentation using just a web browser.

Just access the file ./build/docs/html/index.html on your browser of choice and then you will see the full dcoumentation.

Hosting the documentation using http.server¶

You can host the documentation using Python’s native HTTP Server.

To use it, run the following:

cd pqwidget
python -m http.server 8080 -d ./build/docs/html/

The documentation will now be available at http://localhost:8080.

Note that this server should only be used locally and for test purposes. It is extremely discouraged to use it on production.