openstack
/
qinling
Code Issues Proposed changes
qinling/doc
History
Lingxian Kong f56c67fd89 Add specs folder for Qinling 
We don't need to put the specs files in a separate place to avoid
maintaince overhead, putting them in qinling's repo will also make it
easy to build qinling documenatation.

Change-Id: Ica8c68c6f15f97231a87e9e82fdf2d7e475a6e03
 		2018-03-22 21:22:16 +00:00
..
source Add specs folder for Qinling 2018-03-22 21:22:16 +00:00
README.rst Update qinling doc location to docs.openstack.org 2018-03-02 20:21:18 +08:00
requirements.txt Updated from global requirements 2018-03-15 08:07:43 +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