Files
manila/doc
Carlos Eduardo a0f3a36b10 Updates the share extend and shrink documentation
The share extend and shrink documentation was still using the
manila client, so the examples were now updated to match the
command in OSC.

Closes-Bug: #2084559
Change-Id: Ic23e46b727f4673a6425cde7ed88b1219ed4a874
2024-12-18 07:50:02 -03:00
..
2024-05-01 11:20:23 +09:00

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