jsoref / graylog2-documentation

The Graylog documentation

Building locally

Create and enter the Python virtual environment:

# virtualenv .
# source ./bin/activate

Install Sphinx, the theme we are using, and sphinx-autobuild:

# pip install -r requirements.txt

Build the static documentation and open them in your browser:

# make html
# open _build/html/index.html

Build the documentation and automatically build them on any change:

# make livehtml
# open http://127.0.0.1:8000/

Fedora Linux 22 and higher

# sudo dnf install -y python-sphinx python-sphinx_rtd_theme