openstack
/
manila
Code Issues Proposed changes
manila/doc
History
Danny Al-Gaaf a8ec3317be doc: verify all rst files 
Make use of doc8 to verify all rst files which are not
autogenerated for errors and fail if there are any issues
found. The doc8 checks are now part of the tox 'docs'
environment and ran automatically. Checks can also be called
direcly via 'tox -e docs'.

Fix all issues found by doc8.

Closes-Bug: #1664841

Change-Id: I9215524d35646de7485504e4c5ff86fd91a1d09f
Signed-off-by: Danny Al-Gaaf <danny.al-gaaf@bisect.de>
 		2017-02-15 07:07:42 +01:00
..
ext Removes unnecessary utf-8 coding 2017-01-22 21:20:55 +08:00
source doc: verify all rst files 2017-02-15 07:07:42 +01:00
.gitignore Initialize from cinder 2013-08-08 10:34:06 -04:00
README.rst Fix devref README and remove Makefile 2016-07-25 02:21:10 +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: 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