c591c0da3b
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 |
||
---|---|---|
.. | ||
ext | ||
source | ||
README.rst | ||
requirements.txt |
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