openstack
/
manila
Code Issues Proposed changes
manila/doc
History
zhongjun 5ce0879e23 Add share usage size tracking in doc 
Add share usage size tracking feature description
in driver_requirements doc.

DocImpact

Change-Id: Iaca1bb541a34af862b938e17e4a56d53de7a9cc5
Implement-Blueprint: share-usage-size
 		2017-07-26 12:32:24 +08:00
..
ext Unblock gate failure on docs build 2017-03-03 18:21:45 +02:00
source Add share usage size tracking in doc 2017-07-26 12:32:24 +08:00
.gitignore Initialize from cinder 2013-08-08 10:34:06 -04:00
README.rst Update the documentation link for doc migration 2017-07-14 07:27:16 +00:00
find_autodoc_modules.sh docs 2013-09-17 10:57:47 +03:00
generate_autodoc_index.sh modified docs 2013-09-17 12:21:17 +03: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