qinling/doc
Lingxian Kong 20ac516dac Improve Document for Qinling
Partially implements: blueprint qinling-doc
Change-Id: I1c0df8e737400768fa5a239e15c49ea3fbc4dff3
2017-12-12 12:50:14 +13:00
..
source Improve Document for Qinling 2017-12-12 12:50:14 +13:00
README.rst Add devstack installation doc 2017-09-06 21:52:28 +12:00

Qinling Development Docs

Files under this directory tree are used for generating the documentation for the qinling source code.

Developer documentation is built to: http://qinling.readthedocs.io/en/latest/

Tools

Sphinx

The Python Sphinx package is used to generate the documentation output. Information on Sphinx, including formatting information for RST source files, can be found in the Sphinx online documentation.

Building Documentation

Doc builds are performed using tox with the docs target:

% cd ..
% tox -e docs