openstack
/
manila
Code Issues Proposed changes
manila/doc
History
Yong Huang 26b8d4dc31 [Manila Unity/VNX] admin doc failed to render 
In Dell EMC Unity and VNX admin doc, IPv6 part section failed to render.

Change-Id: I9cfe4681d646cfa7b49ff33c2637cf999d79abd1
Closes-bug: #1778862
(cherry picked from commit 14f9a0b3ad)
 		2018-06-28 05:54:33 +00:00
..
ext doc migration: openstackdocstheme completion 2017-08-24 09:15:18 -04:00
source [Manila Unity/VNX] admin doc failed to render 2018-06-28 05:54:33 +00: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-01-24 01:00:04 +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