openstack
/
cinder
Code Issues Proposed changes
cinder/doc
History
Zhiteng Huang cea7fe21ce Drop Chance/SimpleScheduler Implementation 
This patch removes the implementation of ChanceScheduler and SimpleScheduler
as previous changes have made sure they are internally replaced by
FilterScheduler.

The "max_gigabytes" config option is deprecated and will leave it like that
for one more release before we can remove it.

DocImpact: "ChanceScheduler and SimpleScheduler have been deprecated and
their implementation have been removed from Cinder."

Implement bp: deprecate-chance-and-simple-schedulers

Change-Id: Ifb1cb25e3bb4cdf26fa3283336b83fce5c97141e
 		2014-01-09 18:29:27 +08:00
..
ext Use built-in print() instead of print statement 2013-09-18 08:44:28 -07:00
source Drop Chance/SimpleScheduler Implementation 2014-01-09 18:29:27 +08:00
.gitignore Initial fork out of Nova. 2012-05-03 10:48:26 -07:00
Makefile Initial fork out of Nova. 2012-05-03 10:48:26 -07:00
README.rst Initial fork out of Nova. 2012-05-03 10:48:26 -07:00
find_autodoc_modules.sh Initial fork out of Nova. 2012-05-03 10:48:26 -07:00
generate_autodoc_index.sh Initial fork out of Nova. 2012-05-03 10:48:26 -07: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 cinder 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!