3f24fee218
Moving file flags.py to manila/common/config.py, replacing FLAGS by CONF. Rename modules fake_flags to conf_fixture, test_flags to test_conf, declare_flags to declare_conf, runtime_flags to runtime_conf like it was done in cinder, nova, glance etc. Implement bp: use-oslo-conf Change-Id: I38d869123e5e706d3b06f1844b97ead05e22668f |
||
---|---|---|
.. | ||
ext | ||
source | ||
.gitignore | ||
find_autodoc_modules.sh | ||
generate_autodoc_index.sh | ||
Makefile | ||
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!