13 Commits

Author SHA1 Message Date
Andreas Jaeger
cd56622300 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:44:39 +02:00
Sergey Lukjanov
21f166b623 Start using oslosphinx theme for docs
Change-Id: Ic327d9752e9c77e6543f23b032c8b77abd6ed479
2014-03-26 15:42:03 +04:00
JUN JIE NAN
77fe828870 Added v3 interfaces in reference doc
Added hosts, agents, flavors and so on into reference doc

Change-Id: I32198a0e65551f6ea3c67b72a8d7c6dff7da9f91
2014-01-03 13:57:56 +08:00
JUN JIE NAN
25041fe6fa Enable pep8 check for config.py in doc
Directory doc is excluded from pep8 check in tox.ini, since we
modified file doc/source/config.py, we should enable the check.

Change-Id: I057f1e6cb1c5f9a6a07043056078e4475f66f288
2014-01-03 13:53:53 +08:00
JUN JIE NAN
3582d6f1be Generate interfaces reference doc
Add gen_ref in conf.py to generate reference doc to avoid maintaining
these boilerplates.

Change-Id: I6683c41d39685dcb7f7a619a36210a987c9e9825
2014-01-03 13:51:08 +08:00
JUN JIE NAN
7bd5b78b22 Removed duplicated import
sys is imported twice so removed the second import.

Change-Id: I50531edf856d42ec9b10732eff18a97d0cb3e9cc
2013-12-23 10:36:35 +08:00
JUN JIE NAN
f3d6f1d22c Fixed autodoc can't import/find class error
The right module name should be `novaclient.v1_1.servers' instead of
`novaclient'. Similar fix on `images', `flavors' and `exceptions'.

Removed `ipgroups' and `backup_schedules' since they do not exist any
more.

Closes-Bug: #1056478

Change-Id: Id35f9c275fb36f3651a0bb2b0eb03c43f0aaeec1
2013-12-18 15:56:50 +08:00
Chuck Short
8c4e145b92 python3: Fix unicode compatibility python2/python3
Python3 enforces the distinction between byte strings and text strings
more rigorously than python2. So use six.text_type/six.u()
where appropriate

Change-Id: I890e19cb857e10f0292aabdaebaa8e7a7bd8db23
Signed-off-by: Chuck Short <chuck.short@canonical.com>
2013-06-24 11:47:15 -05:00
Jakub Ruzicka
37da28cff4 Provide nova CLI man page.
Resolves: bug 1130815
Blueprint: clients-man-pages

Provide basic but hopefully useful man page.

Change-Id: I6c520fa3acdb82dd564b758b9cdc448eecc6d6ce
2013-05-29 18:53:42 +02:00
gtt116
dccdd02e48 Cleanup unused import
Change-Id: Id7d110110f238077630c9b9ee4d643654844dd3e
2013-04-17 13:51:37 +00:00
lrqrun
9754f1daa8 Fix PEP8 issues.
Fix some pep8 issues in doc/source/conf.py make the code looks pretty.

Change-Id: I7cc284a0155d531d3890941f8c62c04f54d1a2d6
2012-08-29 13:36:55 +08:00
annegentle
2a97d614b4 Small doc cleanup round.
- Changes theme to default instead of nature.
 - Explains in terms of Compute API instead of Rackspace
 - Remove outdated reference to nova-manage command
 - Remove unnecessary whitespace

Change-Id: I43d16cd053af0b4be48450fd638f9d17f9e5c4e7
2012-06-26 09:29:38 -05:00
Clark Boylan
ebceca9414 Move docs to doc.
To better facilitate the building and publishing of sphinx
documentation by Jenkins we are moving all openstack projects with
sphinx documentation to a common doc tree structure. Documentation
goes in project/doc/source and build results go in project/doc/build.

Change-Id: I868df12e3c15cc30043e782ce0a609b9574295cd
2012-06-11 14:18:48 -07:00