4 Commits

Author SHA1 Message Date
lrqrun
27ba0bb324 Fix PEP8 issues .
Fix some pep8 issues in
       modified:   doc/source/conf.py
       modified:   tests/api/v1/test_list_resources.py
       modified:   tests/collector/test_dispatcher.py
       modified:   tests/compute/test_notifications.py
make the code looks pretty.

Change-Id: I50c167b457b18f3789a3f8d470faa2754a77b604
2012-08-30 11:17:56 +08:00
Doug Hellmann
093c39b952 Add API documentation
Use sphinxcontrib-httpdomain to produce documentation for
the web API. Add docstrings to the exposed functions.

See http://packages.python.org/sphinxcontrib-httpdomain/
for details about the format of the auto-generated
output.

Change-Id: I62edd1d00c048c4bce34711a23686f0089bbf4e7
Signed-off-by: Doug Hellmann <doug.hellmann@dreamhost.com>
2012-08-07 10:19:19 -04:00
Doug Hellmann
1f9bce2609 extend developer documentation
- Add information about the system architecture (modified
  from the wiki to reflect what was implemented).
- Add information about where we want contributions.
- Add information about how to sign up to participate in
  the project and how to be a part of the community.
- Add more detailed instructions for installing the development
  version from git.
- Add a placeholder for documenting the configuration options.
- Add instructions for running the tests after getting
  the source code.
- Add a glossary and index.

tags: DocImpact
bug 1006366

Change-Id: I8927c55e77cdd31804249d101575f9e174e6232d
Signed-off-by: Doug Hellmann <doug.hellmann@dreamhost.com>
2012-07-05 14:46:37 -04:00
Doug Hellmann
4bcd1c46a0 Add Sphinx wrapper around existing docs
bug 1018443

This patch sets up a basic Sphinx project to allow us to
build the documentation. It also moves the "dev" docs
into the new doc source directory.

Change-Id: Ie2ad0f2e4ed237f1373c4357d5763fd5218d738a
2012-06-27 11:39:37 -04:00