openstack
/
manila
Code Issues Proposed changes
manila/doc
History
liuyamin bd6c800f8f Update auth_url value in install docs 
Follow the keystone install guide by using port 5000 as the default
auth_url, this change is to update manila install guide on the version
of Queens.

Change-Id: I8862e2906d0a1eb6f5b900205b39456f6543c14c
Closes-bug: #1754104
 		2018-05-11 12:45:28 +08:00
..
ext doc migration: openstackdocstheme completion 2017-08-24 09:15:18 -04:00
source Update auth_url value in install docs 2018-05-11 12:45:28 +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-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