openstack/skyline-apiserver
Code Issues Proposed changes
69271313e3
skyline-apiserver/doc
History
yangshaoxue c7c346de9a fix: Fix keystone_url default sample 
Fixed the issue that keystone_url's default sample was incorrect

Change-Id: I0e5157c1f2cb3a89f3abcd6decc3371116a79835
2022-12-15 15:20:06 +08:00
..
source fix: Fix keystone_url default sample 2022-12-15 15:20:06 +08:00
README.rst feat: Add doc base frame 2022-07-29 14:31:57 +08:00
requirements.txt feat: Add doc base frame 2022-07-29 14:31:57 +08:00

README.rst

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.

Graphviz

Some of the diagrams are generated using the dot language 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