History

Goutham Pacha Ravi cdb1422fe1 Remove broken modindex link from devref

It was pointed out by the Docs team that we have
one unresolved link [1] in our devref.

Let's torch it with fire.

[1] http://lists.openstack.org/pipermail/openstack-docs/2016-October/009274.html

TrivialFix

Change-Id: Ie73890c8d6db816d8ddd582f1bcefc5cddab21d8

2016-10-30 17:30:59 -04:00

ext

py3: use six.moves.range instead of xrange

2014-12-27 18:41:21 +08:00

source

Remove broken modindex link from devref

2016-10-30 17:30:59 -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