manila/doc
Goutham Pacha Ravi cf83f96200 [cycle-goals] Add PTL and contributor quickstart
These documents borrow from the cinder, nova and
ironic guides put together painstakingly by
numerous developers.

Change-Id: Ida3480fd1b9cab8eeb9ad002cce7200d89e01cb6
Story: #2007236
Task: #38535
Signed-off-by: Goutham Pacha Ravi <gouthampravi@gmail.com>
2020-04-18 22:29:50 +00:00
..
ext doc migration: openstackdocstheme completion 2017-08-24 09:15:18 -04:00
source [cycle-goals] Add PTL and contributor quickstart 2020-04-18 22:29:50 +00:00
README.rst Update the documentation link for doc migration 2017-07-14 07:27:16 +00:00
requirements.txt Cleanup Python 2.7 support 2020-03-27 16:55:52 +01: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