openstack
/
manila
Code Issues Proposed changes
manila/doc
History
junboli b30851f3af Fix incorrect literal_block error when build docs 
This causes failure when use build_sphinx to generate docs.
Fix it by replace the ini code block  with console.

Change-Id: Iaf15fc99fefceb58c765fabc947f99ad8225723b
Closes-bug: #1713291
(cherry picked from commit aa9b9df84c)
 		2017-08-28 12:26:16 +00:00
..
ext doc migration: openstackdocstheme completion 2017-08-25 13:54:48 -04:00
source Fix incorrect literal_block error when build docs 2017-08-28 12:26:16 +00:00
.gitignore doc migration: new directory layout 2017-08-25 13:58:26 -04:00
README.rst Update the documentation link for doc migration 2017-07-14 07:27:16 +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: https://docs.openstack.org/manila/latest/

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