openstack
/
manila
Code Issues Proposed changes
manila/doc
History
Thomas Bechtold fd9b5c0435 Fix doc build if git is absent 
When building packages if git is absent, then we should not set
html_last_updated_fmt. It can still be set via the -D switch
when building with sphinx-build.

Change-Id: I02a6bcb43c8283848fb3866bb52cc4c0f50f4c92
Closes-Bug: #1552251
 		2016-04-13 09:36:41 +02:00
..
ext py3: use six.moves.range instead of xrange 2014-12-27 18:41:21 +08:00
source Fix doc build if git is absent 2016-04-13 09:36:41 +02:00
.gitignore Initialize from cinder 2013-08-08 10:34:06 -04:00
Makefile docs 2013-09-17 10:57:47 +03:00
README.rst docs 2013-09-17 10:57:47 +03: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

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

  1. Generate the code.rst file so that Sphinx will pull in our docstrings:

    % ./generate_autodoc_index.sh > source/code.rst

  2. Run `sphinx_build`:

    % sphinx-build -b html source build/html

The docs have been built

Check out the build directory to find them. Yay!