glances/docs
2016-03-12 10:15:44 +01:00
..
_static Use Sphinx for doc 2016-03-06 19:16:37 +01:00
_templates Use Sphinx for doc 2016-03-06 19:16:37 +01:00
aoa Use Sphinx for doc 2016-03-06 19:16:37 +01:00
gw Use Sphinx for doc 2016-03-06 19:16:37 +01:00
man Workaround for the documentation version issue 2016-03-12 10:15:44 +01:00
api.rst Use Sphinx for doc 2016-03-06 19:16:37 +01:00
cmds.rst Use Sphinx for doc 2016-03-06 19:16:37 +01:00
conf.py Use Sphinx for man page 2016-03-06 19:16:37 +01:00
config.rst Use Sphinx for doc 2016-03-06 19:16:37 +01:00
glances.rst Use Sphinx for man page 2016-03-06 19:16:37 +01:00
index.rst Use Sphinx for doc 2016-03-06 19:16:37 +01:00
make.bat Use Sphinx for doc 2016-03-06 19:16:37 +01:00
Makefile Workaround for the documentation version issue 2016-03-12 10:15:44 +01:00
quickstart.rst Use Sphinx for doc 2016-03-06 19:16:37 +01:00
README.txt Workaround for the documentation version issue 2016-03-12 10:15:44 +01:00
support.rst Use Sphinx for doc 2016-03-06 19:16:37 +01:00

Building the docs
=================

First install Sphinx:

    pip install sphinx

or update it if already installed:

    pip install --upgrade shpinx

Go to the docs folder:

    cd docs

Edit the Makefile (line 5):

    SPHINXOPTS    = -D version=2.6 -D release=2.6_RC1

Then build the HTML documentation:

    make html

and the man page:

    make man