History

Pete Zaitcev c2f1d714f4 Use oslosphinx and remove local copy of doc theme A packaging review in Fedora found that we had a copy of jQuery code. Apparently, other OpenStack projects applied a patch to remove this code, but Manila forked Cinder code from before. The across-the-board change in OpenStack missed Manila, because we weren't incubated yet. This patch is almost an exact copy of Cinder patch, but not cherry- picked because of additional changes, such as the move from oslo.sphinx to oslosphinx. Patch is verified to produce readable documentation. Change-Id: Id0b57f89ae6b63b26b7f0c3fa9af5a529e92ac69		2014-09-08 09:46:23 -06:00
..
ext	Update manila's docs	2014-06-23 19:19:28 +03:00
source	Use oslosphinx and remove local copy of doc theme	2014-09-08 09:46:23 -06: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

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!