openstack
/
manila
Code Issues Proposed changes
manila/doc
History
Goutham Pacha Ravi 7dd147874d Fix ZFSOnLinux doc about manage ops 
Trivial documentation update that was
discovered when building a scenario test [1]
for the manage/unmanage operations with
the ZFSOnLinux driver.

[1] I4245cd202543cfefb0aa4e9c56ab949e2a9821f6

Change-Id: I92e4467319e4d0682581cce83a2f0c959d1b9555
 		2018-08-02 20:57:32 +00:00
..
ext doc migration: openstackdocstheme completion 2017-08-24 09:15:18 -04:00
source Fix ZFSOnLinux doc about manage ops 2018-08-02 20:57:32 +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-03-23 01:06:24 +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