openstack
/
keystone
Code Issues Proposed changes
keystone/doc
History
Ziad Sawalha df6e1c9640 Use TENANT_ID if it exists, but still support X_TENANT. 
This continues support for middleware that is using the older data model where tenantId and tenantName were the same thing. X_TENANT is what is in the URL in Keystoe.

Added documentation on Middleware headers and HTTP API interactions.

Change-Id: I65a31ab07eb18d6882977acc64679c873b951bfb
 		2011-11-10 10:14:39 -06:00
..
design Changes suggested by Ziad.Adding validateToken operation. 2011-07-28 09:51:13 -07:00
source Use TENANT_ID if it exists, but still support X_TENANT. 2011-11-10 10:14:39 -06:00
Makefile Adds Sphinx build ability and RST documentation. 2011-06-14 15:19:49 -04:00
README.rst Removed contributor doc build info from project README (bug #843056) 2011-10-26 11:05:04 -05: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 fixing search sequence to not include directory structure from os.walk() 2011-10-27 13:51:06 -07:00

README.rst

Building Contributor Documentation

This documentation is written by contributors, for contributors.

The source is maintained in the doc/source folder using reStructuredText and built by Sphinx (a dependency from tools/pip-requires).

Building automatically

From the project root, just type:

$ python setup.py build_sphinx

Building manually

  1. Generate the code.rst file so that Sphinx will pull in our docstrings:

    $ python doc/generate_autodoc_index.py

  2. Use sphinx-build to produce the docs in HTML:

    $ sphinx-build -b html doc/source/ build/sphinx/html/

  3. Similarly, build the man pages (optional):

    $ sphinx-build -b man doc/source/ build/sphinx/man/

After building

Navigate to the build/sphinx/html directory to browse generated the HTML docs.