openstack
/
manila
Code Issues Proposed changes
manila/doc
History
Goutham Pacha Ravi c591c0da3b Update IRC references 
OpenStack community is moving irc servers [1][2]
by 31st May 2021. Since we refer to freenode by name
in a couple of places, we can change those to point
to OFTC, the new hub.

[1] http://lists.openstack.org/pipermail/openstack-discuss/2021-May/022718.html
[2] http://lists.openstack.org/pipermail/openstack-discuss/2021-May/022724.html

Change-Id: Ic54ab0c40deb5ac0c519f9e4e54298eee6284c32
Signed-off-by: Goutham Pacha Ravi <gouthampravi@gmail.com>
(cherry picked from commit 865aac4ace)
(cherry picked from commit 1f4214d871)
(cherry picked from commit 21102351db)
 		2021-05-27 18:39:54 +00:00
..
ext doc migration: openstackdocstheme completion 2017-08-24 09:15:18 -04:00
source Update IRC references 2021-05-27 18:39:54 +00:00
README.rst Update the documentation link for doc migration 2017-07-14 07:27:16 +00:00
requirements.txt Cleanup Python 2.7 support 2020-03-27 16:55:52 +01:00

README.rst

Manila Development Docs

Files under this directory tree are used for generating the documentation for the manila source code.

Developer documentation is built to: https://docs.openstack.org/manila/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