Documentation

You are welcome to extend sampik’s documentation! All help is appreciated.

Using reStructedText

• Basics of rST

• Documenting C++ with rST

Building a local copy of the docs

First, create a virtual environment at ./.venv:

$ python3 -m venv .venv

Activate the virtual environment:

$ source .venv/bin/activate

Install the required packages for building the docs:

$ pip install -r docs/requirements.txt

Build the documentation:

$ make -C docs html

You can then open the documentation in your favorite browser:

$ $BROWSER docs/_build/html/index.html