openstack/manila
Code Issues Proposed changes
9157b8afb2
manila/doc
History
jeckxie 687b6aa535 Add Apache 2.0 license to source file 
As per OpenStack licensing guide lines [1]:
[H102 H103] Newly contributed Source Code should be licensed under the Apache 2.0 license.

[1] http://docs.openstack.org/developer/hacking/#openstack-licensing

Change-Id: Ib3cb284f5232b4641058d262160d4204566e1904
2016-12-19 19:45:43 +08:00
..
ext Add Apache 2.0 license to source file 2016-12-19 19:45:43 +08:00
source [devref] copy samples/local.conf correctly 2016-12-18 14:57:00 -05:00
.gitignore Initialize from cinder 2013-08-08 10:34:06 -04:00
find_autodoc_modules.sh docs 2013-09-17 10:57:47 +03:00
generate_autodoc_index.sh modified docs 2013-09-17 12:21:17 +03:00
README.rst Fix devref README and remove Makefile 2016-07-25 02:21:10 +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: http://docs.openstack.org/developer/manila/

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