manila/doc
Tom Barron 66a6505d79 remove hacking rule that enforces log translation
Log translation is no longer being done [1] [2] so there
is no point in enforcing it going forwards.

Remove the hacking enforcement so that new commits need
not include this unused feature and so that we can remove
this unused il8n markup in existing code.

[1] http://lists.openstack.org/pipermail/openstack-dev/2017-March/thread.html#113365
[2] https://review.openstack.org/#/c/446762/

Change-Id: I31f35b0597e161a1654467f5a0a2348789292d83
2017-03-17 05:54:03 -04:00
..
ext Unblock gate failure on docs build 2017-03-03 18:21:45 +02:00
source remove hacking rule that enforces log translation 2017-03-17 05:54:03 -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

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