qinling/doc
Zuul 34b5b5aa1f Merge "Some improvements for the doc" 2018-11-06 10:02:21 +00:00
..
source Merge "Some improvements for the doc" 2018-11-06 10:02:21 +00:00
README.rst Update qinling doc location to docs.openstack.org 2018-03-02 20:21:18 +08:00
requirements.txt Use storyboard to collect documentation bugs 2018-09-19 02:09:23 +00:00

README.rst

Qinling Development Docs

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

Developer documentation is built to: https://docs.openstack.org/qinling/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