History

junboli 6d82f675b8 Fix title overline too short when generate docs when running tox -e docs locally, it failed because the title overline too short. Change-Id: I9b1d85f12ff559e032c465d7737e9c27efb459c3 Closes-bug: #1769073		2018-05-04 00:00:00 +08:00
..
ext	doc migration: openstackdocstheme completion	2017-08-24 09:15:18 -04:00
source	Fix title overline too short when generate docs	2018-05-04 00:00:00 +08:00
README.rst	Update the documentation link for doc migration	2017-07-14 07:27:16 +00:00
requirements.txt	Updated from global requirements	2018-03-23 01:06:24 +00: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