openstack/manila
Code Issues Proposed changes
1384257e4f
manila/doc
History
Goutham Pacha Ravi 2b389ce1e1 [Docs] Don't include unittest documentation 
The `test_quota` and `test_policy` modules
don't need to be documented, since they present
no meaningful information to contributors.

Removing these also avoids the docstring
formatting issues that ddt may introduce
to the sphinx build. [1]

[1] https://github.com/datadriventests/ddt/pull/51

Change-Id: I8136e8a000e04bcc213a746c7d793bf9373b1b38
Closes-Bug: #1783124
2018-07-23 08:43:16 -07:00
..
ext doc migration: openstackdocstheme completion 2017-08-24 09:15:18 -04:00
source [Docs] Don't include unittest documentation 2018-07-23 08:43:16 -07:00
README.rst Update the documentation link for doc migration 2017-07-14 07:27:16 +00:00
requirements.txt Updated from global requirements 2018-03-23 01:06:24 +00: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