skyline-apiserver/doc/README.rst
Boxiang Zhu 7ba07dbf70 feat: Add doc base frame
Add doc base frame

Change-Id: Id0a4168873232ef7feedaf1e1c1b6ed2b69a8f17
2022-07-29 14:31:57 +08:00

34 lines
920 B
ReStructuredText

==================================
Skyline APIServer Development Docs
==================================
Files under this directory tree are used for generating the documentation
for the skyline-apiserver source code.
Developer documentation is built to:
https://docs.openstack.org/skyline-apiserver/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
<http://www.sphinx-doc.org/en/stable/>`_.
Graphviz
Some of the diagrams are generated using the ``dot`` language
from Graphviz. See the `Graphviz documentation <http://www.graphviz.org/>`_
for Graphviz and dot language usage information.
Building Documentation
======================
Doc builds are performed using tox with the ``docs`` target::
% cd ..
% tox -e docs