Installing

Below is described how to do a release install and a development install of Doctools.

Guarantee to work with Python newer than 3.8 and distros released on or after 20H1 (e.g. Ubuntu 20.04 LTS).

Release install

Ensure pip is newer than 23.0 [1]:

~$

pip install pip --upgrade

Install the documentation tools, which will fetch this repository release:

~$

(cd docs ; pip install -r requirements.txt)

Test it building this documentation:

~$

(cd docs ; make html)

[1]

There is a known bug with pip shipped with Ubuntu 22.04.

Using a Python virtual environment

Installing packages at user level through pip is not always recommended, instead, consider using a Python virtual environment (python3-venv on ubuntu 22.04).

To create and activate the environment, do before the previous instructions:

~$

python3 -m venv venv

~$

source venv/bin/activate

Use deactivate to exit the virtual environment.

For next builds, just activate the virtual environment:

~$

source venv/bin/activate

Development install

Development install allows to edit the source code and apply the changes without reinstalling. Also extends Author Mode to watch changes on the webpage source code (use –dev/-r option to enable this).

Install the web compiler

If you care about the web scripts (js modules) and style sheets (sass), install node.js, npm and the npm packages below, if not, read this section’s last paragraph.

Note

If the npm provided by your package manager is too old and updating with npm install npm -g fails, consider installing with NodeSource.

At the repository root, install the npm dependencies locally:

~$

npm install rollup \
    @rollup/plugin-terser \
    sass \
    --save-dev

If you choose to not use npm, you can obtain pre-built web-scripts from the latest release. For that, just run Serve after the repository is installed and confirm the prompt that will appear.

Fetch third-party resources

Fetch third-party fonts:

~$

./ci/fetch-fonts.sh

Install the repository

Finally, do a symbolic install of this repo:

~$

pip install -e . --upgrade

Caution

If using a python virtual enviroment for the requirements.txt packages. do this command with the virtual enviroment already activated.

Mixing pip packages inside and outside the virtual enviroment will cause packages outside of the enviroment to not have access to the packages inside of it, breaking most CLIs.

Removing

To remove, either release or development, do:

~$

pip uninstall adi-doctools