7dd147874d
Trivial documentation update that was discovered when building a scenario test [1] for the manage/unmanage operations with the ZFSOnLinux driver. [1] I4245cd202543cfefb0aa4e9c56ab949e2a9821f6 Change-Id: I92e4467319e4d0682581cce83a2f0c959d1b9555 |
||
---|---|---|
.. | ||
ext | ||
source | ||
README.rst | ||
requirements.txt |
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