History

Joe Heck 20c2adb9ac updating keystone developer documentation updating docstrings to remove errors in automodule generation updating setup.py to generate source documentation blueprint keystone-documentation bug 843056 Change-Id: Ie8dfedc89c1a6d9ffa5106d29dd19837b02746ce		2011-10-21 16:39:46 -07:00
..
design	Changes suggested by Ziad.Adding validateToken operation.	2011-07-28 09:51:13 -07:00
source	updating keystone developer documentation	2011-10-21 16:39:46 -07:00
Makefile	Adds Sphinx build ability and RST documentation.	2011-06-14 15:19:49 -04:00
README.rst	updating keystone developer documentation	2011-10-21 16:39:46 -07:00
__init__.py	Added py init files to directories already being referenced as modules	2011-06-15 14:27:19 -05:00
generate_autodoc_index.py	updating keystone developer documentation	2011-10-21 16:39:46 -07:00

README.rst

Building the Documentation

Using setup.py

From the project root, just type:

% setup.py build_sphinx

Manually

Generate the code.rst file so that Sphinx will pull in our docstrings:
% ./generate_autodoc_index.py
Run `sphinx_build`:
% sphinx-build -b html source build/html

The docs have been built

Check out the build directory to find them. Yay!