Build the documentation

Build locally

1. Change dir to docs/ and build documentation webpage

$ cd docs
$ make html

Will create the file docs/build/html/index.html and all static resources.

2. Show docs in browser

$ python -m http.server --directory build/html

Should open the documentation website at http://localhost:8000, or http://127.0.0.1:8000 or http://YOUR.HOSTNAME:8000

Github pages

To create a real website with a proper https://... URL, some additional works is due:

1. Create gh-pages branch:

• On the repo's main page, click

• create new branch, name "gh-pages"

2. Activate gh-pages

• In Settings -> Pages, settings should look like this:

3. Allow workflows to write to your repo:

• Setting -> Actions -> General should look like this:

4. Link to your website

On the repo website, click the gear icon next to the "About" in the top right corner:

Activate "Use your github pages website"

Now, when making a release (see Make a release), the documentation website will appear as a separate stand-alone website. To get to it, follow the link listed in the "About" section in the top right corner of your repo page.