openstack
/
keystone
Code Issues Proposed changes
keystone/doc
History
Ziad Sawalha e03ff6e291 Updates to middleware to deprecate X_USER 
- There is an outstanding issue where we return the user id
  for the legacy X-User header, but the documentation says
  it should be the 'name the user logged in with'. I did not
  fix this in this commit until we discuss with other teams.

Change-Id: Ibf2acf5bb594b889b5c220ea00d777ac528175b0
 		2012-01-19 11:40:21 -06:00
..
design Added original tenants blueprint to docs 2011-12-09 16:29:33 -06:00
source Updates to middleware to deprecate X_USER 2012-01-19 11:40:21 -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 Eliminated debug output from sphinx_build (bug 898211) 2011-11-30 10:12:11 -06: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.