History

Csaba Henk 1fda615f6f glusterfs_native: relocate module under glusterfs

Having a driver in the top level of the drivers
directory was against source tree placement
conventions. It was especially weird because
all other GlusterFS related code lived in
a dedicated subdirectory.

Partially implements bp gluster-code-cleanup

Change-Id: I52d717ab6396454c2e7a9b62aa00ea443b26d5cc

2016-03-01 10:56:49 +01:00

ext

py3: use six.moves.range instead of xrange

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

source

glusterfs_native: relocate module under glusterfs

2016-03-01 10:56:49 +01: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!