openstack/skyline-console
Code Issues Proposed changes
decd2bfec7
skyline-console/doc
History
lcyuzzz 72eb092e86 Remove unicode literal from code 
All strings are considered as unicode literal string from Python 3.

Closes bug: #1995548

Change-Id: I14a37c888b0ddb74581c0db257830c34290eb96c
2022-11-03 15:40:19 +08:00
..
source Remove unicode literal from code 2022-11-03 15:40:19 +08:00
README.rst feat: Add doc base frame 2022-08-01 14:28:07 +08:00
requirements.txt feat: Add doc base frame 2022-08-01 14:28:07 +08:00

README.rst

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 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