History

chenxing 082159cc54 Update the documentation link for doc migration Change-Id: I0b4e59c9e2ad0375cdb6aae5369a7b43978c3d69		2017-07-14 07:27:16 +00:00
..
ext	Unblock gate failure on docs build	2017-03-03 18:21:45 +02:00
source	Update the documentation link for doc migration	2017-07-14 07:27:16 +00: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

Manila Development Docs

Files under this directory tree are used for generating the documentation for the manila source code.

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.

Doc builds are performed using tox with the docs target:

% cd ..
% tox -e docs