openstack/manila
Code Issues Proposed changes
aaf6086ccf
manila/doc
History
Goutham Pacha Ravi 8de817d16e Developer Reference: Adopt the openstackdocstheme 
To allow for our developer reference to be consistent with
the rest of the openstack documentation, we need to import
and render this theme on our developer reference.

This gives users a consistent experience as they may
be acquainted with the rest of the OpenStack documentation
(Admin Guide, User Guide, API Guide etc.)
before perusing the Manila developer reference.

It also provides our devref the "log-a-bug" feature so
readers may bring any mis-information to our attention.

This patch is part of a series of commits to improve
in-tree documentation.

Change-Id: I0e4686a273c5bf45c1d57764cd4c312870b06d6e
Partially-implements: bp improve-manila-developer-docs
2016-05-05 17:15:41 +00:00
..
ext py3: use six.moves.range instead of xrange 2014-12-27 18:41:21 +08:00
source Developer Reference: Adopt the openstackdocstheme 2016-05-05 17:15:41 +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

  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!