History

Sumit Kumar 724d8dfa0a Fix docs for REST API history and Scheduler

In manila/api/openstack/rest_api_version_history.rst,
underscores were used instead of hyphens to underline version '2.14'.
Fix to remove visual incongruity.

In doc/source/devref/scheduler.rst, not all drivers were added or
updated. Fix to include all drivers.

Partially-implements bp improve-manila-developer-docs

Change-Id: I513a4b51ab5f3d8c0cdb5aa013c93ecd07a85a20

2016-05-16 14:32:29 -04:00

ext

py3: use six.moves.range instead of xrange

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

source

Fix docs for REST API history and Scheduler

2016-05-16 14:32:29 -04: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!