f1f9e61fd4
Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using these versions will allow especially: * Linking from HTML to PDF document * Allow parallel building of documents * Fix some rendering problems Update Sphinx version as well. Disable openstackdocs_auto_name to use 'project' variable as name. Change pygments_style to 'native' since old theme version always used 'native' and the theme now respects the setting and using 'sphinx' can lead to some strange rendering. Remove docs requirements from lower-constraints, they are not needed during install or test but only for docs building. openstackdocstheme renames some variables, so follow the renames before the next release removes them. A couple of variables are also not needed anymore, remove them. See also http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html Change-Id: I301ebb5ae44e9e5f1848e59865cc1d9dcdeffd8b |
||
|---|---|---|
| .. | ||
| source | ||
| README.rst | ||
| requirements.txt | ||
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