7 Commits

Author SHA1 Message Date
Ian Wienand
f272ab3ae4 Generate API documentation
As a new user I found navigating the documentation difficult.  The
flow was a bit unclear and searches bring up old versions of API
references that aren't included in the current documentation.

This
 - provides an introduction to the tools similar to other projects
 - generates API references for the v1 and v2 client
 - fixes some minor docstring issues
 - adds doc/* to pep8 tests to check the conf.py

The API generation code is cribbed from python-novaclient

Change-Id: I65772127679d7afd5e7e48ca7872366b01382f21
2015-02-16 11:09:00 +11:00
Andreas Jaeger
ab07caf8c0 Stop using intersphinx
Remove intersphinx from the docs build as it triggers network calls that
occasionally fail, and we don't really use intersphinx (links other
sphinx documents out on the internet)

This also removes the requirement for internet access during docs build.

This can cause docs jobs to fail if the project errors out on
warnings.

Change-Id: I71e941e2a639641a662a163c682eb86d51de42fb
Related-Bug: #1368910
2014-09-13 09:40:28 +02:00
Steve Martinelli
7736349b1e Update theme for docs
The current developer docs theme used is out of sync with the other
openstack projects. This patch will update the docs to provide a more
consistent look and feel when using developer docs

Change-Id: I4a59f194bd0fc8c86c6d3c6b8cadb839a5158935
2014-07-24 20:42:56 -04:00
Wu Wenxiang
80cf47e229 Remove unused imports
Remove unused imports in doc/source/conf.py

Change-Id: Ie5f914ca21ee4229686deec01acd788acd4946b7
Closes-Bug: #1265265
2014-01-01 11:39:31 +08:00
Jakub Ruzicka
d1aded801f Provide glance CLI man page.
Provide basic but hopefully useful man page.

Also update OpenStack LCC to OpenStack Foundation in docs.

Resolves: bug 1193111
Implements blueprint: clients-man-pages
Change-Id: I9502b3d5ca75149d747d523934a6401e435924b7
2013-07-25 12:46:14 -04:00
lrqrun
61567bad1e Fix PEP8 issues.
Fix some pep8 issues in doc/source/conf.py  make the code looks pretty.

Change-Id: I44f8152de76ae217d1dd81c9c0c1b1e075ec8792
2012-09-10 10:42:22 +08:00
Monty Taylor
6e1157059e Add initial docs.
Change-Id: I1f8407597105a914945c932ff55945c8005e273c
2012-06-14 14:24:05 -04:00