openstack/manila
Code Issues Proposed changes
c60cd59ef6
manila/doc
History
luqitao 2a6d9fa832 Add support for Guru Meditation Reports for manila 
Oslo_reports enables OpenStack projects to dump Guru Meditation
Reports with useful debugging information to files or stderr.
By default it will genarate report to stdout stream.
To configure GMR you have to add the following section
to manila.conf:

[oslo_reports]
log_dir = '/path/to/logs/dir'

Implements: blueprint guru-meditation-report

Change-Id: Ia730d56374764231e5ec88f0b71ff8e23361fa6a
2017-06-22 23:27:04 -04:00
..
ext Unblock gate failure on docs build 2017-03-03 18:21:45 +02:00
source Add support for Guru Meditation Reports for manila 2017-06-22 23:27:04 -04:00
.gitignore Initialize from cinder 2013-08-08 10:34:06 -04: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 Fix devref README and remove Makefile 2016-07-25 02:21:10 +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: http://docs.openstack.org/developer/manila/

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