0213d8c6d6
Add config/config.yaml to set default configurations. Use the config/local_config.yaml to set the custom configurations Change-Id: I22049e478b6440c765751c8f17663f36f33c277a |
||
|---|---|---|
| .. | ||
| source | ||
| README.rst | ||
| requirements.txt | ||
Skyline Console Development Docs
Files under this directory tree are used for generating the documentation for the skyline-console source code.
Developer documentation is built to: https://docs.openstack.org/skyline-console/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.
- Graphviz
-
Some of the diagrams are generated using the
dotlanguage from Graphviz. See the Graphviz documentation for Graphviz and dot language usage information.
Building Documentation
Doc builds are performed using tox with the docs
target:
% cd ..
% tox -e docs