openstack
/
manila
Code Issues Proposed changes
manila/doc
History
Douglas Viroel 3ca9c7678e Add share server migration admin documentation 
Partial-Bug: #1897903
Change-Id: Ia6dd260e6d2f9e2a7d9d381d345d952a3069f8c5
Signed-off-by: Douglas Viroel <viroel@gmail.com>
 		2020-10-08 09:43:09 -03:00
..
ext doc migration: openstackdocstheme completion 2017-08-24 09:15:18 -04:00
source Add share server migration admin documentation 2020-10-08 09:43:09 -03:00
README.rst Update the documentation link for doc migration 2017-07-14 07:27:16 +00:00
requirements.txt Use unittest.mock instead of mock 2020-06-09 01:21:20 +02: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