Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

54 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages