To get started, you will need to install the documentation dependencies from the project root:

poetry install --extras docs

The following command (run from project root) will launch a live-reloaded session of the documentation in your browser, effectively combining the steps detailed in the following sections:

poetry run make -C docs live

You will need to activate the virtual environment in order to use the dependencies that were just installed:

poetry shell

Your prompt should now have a prefix, e.g.:

(pyscript-cli-_y5OiBT8-py3.9) mattkram [~/dev/pyscript-cli] $

The live mode will allow you to generate the documentation with live reload.

From the project root, run the following command :

make -C docs live

Or, alternately, navigate to the docs directory and run:

make live

Either of the above commands should launch a live dev server and you will be able to view the docs in your browser. As the files are updated, the docs should be refreshed.

If you don't want to use the live reload mode, simply replace either command above with html, e.g.:

make -C docs html