History

Goutham Pacha Ravi 3a4c77790a Document instructions for documentation

A lot of things have been changing with OpenStack's
documentation. As a community, we could do a better
job at catching up with these changes and
documenting our project well enough for the
benefit of all stakeholders.

Add instructions on where to document what and
provide tips to manila developers on documentation.

Change-Id: I660bfd5ac3d61c253e1e7b4b02c51424a03fa0a0
Partially-implements: bp improve-manila-developer-docs

2016-05-31 13:32:27 +00:00

ext

py3: use six.moves.range instead of xrange

2014-12-27 18:41:21 +08:00

source

Document instructions for documentation

2016-05-31 13:32:27 +00: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

Makefile

docs

2013-09-17 10:57:47 +03:00

README.rst

docs

2013-09-17 10:57:47 +03:00

README.rst

Building the docs

Dependencies

Sphinx

You'll need sphinx (the python one) and if you are using the virtualenv you'll need to install it in the virtualenv specifically so that it can load the manila modules.

pip install Sphinx

Graphviz

Some of the diagrams are generated using the dot language from Graphviz.

sudo apt-get install graphviz

Use make

Just type make:

% make

Look in the Makefile for more targets.

Manually

Generate the code.rst file so that Sphinx will pull in our docstrings:
% ./generate_autodoc_index.sh > source/code.rst
Run `sphinx_build`:
% sphinx-build -b html source build/html

The docs have been built

Check out the build directory to find them. Yay!