Name		Name	Last commit message	Last commit date
parent directory ..
_static		_static
autogen		autogen
recipe_book		recipe_book
release_notes		release_notes
source		source
tutorials		tutorials
vendors		vendors
.gitignore		.gitignore
Makefile		Makefile
README.rst		README.rst
architecture.rst		architecture.rst
conf.py		conf.py
configuration.rst		configuration.rst
developer_guide.rst		developer_guide.rst
external_resources.rst		external_resources.rst
fuzzing.rst		fuzzing.rst
index.rst		index.rst
installation.rst		installation.rst
intro.rst		intro.rst
monitoring.rst		monitoring.rst
requirements.txt		requirements.txt
testing.rst		testing.rst

README.rst

Faucet Documentation

Viewing documentation

Docs are viewable on docs.faucet.nz.

Building documentation

sudo apt-get install librsvg2-bin
sudo pip3 install -r requirements.txt
make html