Skip to content

Latest commit

 

History

History
57 lines (32 loc) · 983 Bytes

README.rst

File metadata and controls

57 lines (32 loc) · 983 Bytes

Build the docs

You need make in either scenarios, so first:

# On Debian based systems:
sudo apt-get install make

Build locally using pip

First, install the python3 dependencies:

# On Debian based systems:
sudo apt-get install python3 python3-pip python3-setuptools python3-virtualenv python3-wheel

Create a virtualenv and install Sphinx:

python3 -m virtualenv -p /usr/bin/python3 .venv

source .venv/bin/activate

pip install -r requirements.txt

Now that's done, you can build the docs:

make html

Serve it locally:

cd _build/html
python3 -m http.server

Read it here.

Build the docker image

That's easy:

make docker
docker run -p 127.0.0.1:8080:80 workshop-docs

You can now read the docs here.