Commit Graph

15 Commits

Author SHA1 Message Date
Daniel P. Berrange 4837c42127 Add formal doc recording hypervisor feature capability matrix
Add document to replace / obsolete the giant table on

  https://wiki.openstack.org/wiki/HypervisorSupportMatrix

This initial draft is a fairly straightforward conversion of
that table. Over time, it needs much work to improve the coverage
of API operations and and coverage of important configuration
information that users will care about.

It is using the .ini file syntax in order to record the data in
an easily machine parsable format, while remaining human friendly
by avoiding the syntax heavy approach of XML / JSON / YAML

An extension is registered with sphinx that can convert the
.ini file content into docutils content that then gets rendered
into the developer docs, linked from the index page

Change-Id: I4d3db4bce5737dba30a026a11083a9ea64459cd4
2015-02-03 15:15:49 +00:00
Boris Pavlovic 2dce8c92f6 Remove usage of locals() for formatting from nova.api.*
Using of locals() for formatting string is a nasty thing because:
1) It is not so clear as using explicit dicts
2) It could produce hidden errors during refactoring
3) Changing name of variable causes change in message
4) Creating a lot of unused variables

fixes bug 1171936
Change-Id: I293d7ebb875f65cce322d4938d1ae323f3aded8d
2013-05-18 00:04:17 +04:00
lrqrun 9ddd714f08 Fix PEP8 issues.
Fix some pep8 issues in doc/ext/nova_todo.py make the code looks pretty.

Change-Id: I026c873b487b507a758a2cdb70b444b64702b7fa
2012-08-28 23:13:11 +08:00
Ray Chen 9424514e6f Fix PEP8 issues
Fix some PEP8 issues in doc/ext/nova_todo.py and doc/source/conf.py
and make the code look more clearly.

Change-Id: I2b0ce1b09a4a707cffaa565747aabd5346eb9f41
2012-08-17 11:35:57 +08:00
Monty Taylor eb2de037a3 Update common setup code to latest.
This gets us up to date with common/setup.py and replaces custom nova
autodoc generation with the port of that code found in common.

Change-Id: I2a1c5d2c0fdcf40dbea50cc123b537adb068cdc2
2012-07-07 16:32:19 -05:00
Monty Taylor 702a4743f0 Get rid of all of the autodoc import errors.
This hasn't worked right in a bazillion years.

Change-Id: I4db20ce97f920cdb7254d51e18a0630b0283b39d
2012-03-05 20:22:51 -08:00
Doug Hellmann 1ea445c377 blueprint sphinx-doc-cleanup
bug 944381

Add logic to generate_autodoc_index.sh to produce rst underlines to match the heading strings.

Change-Id: Ib0f54a45fcc4ab6dfaa593c756682f1a25fdb420
2012-03-01 17:03:01 -05:00
Vishvananda Ishaya 20b4d89512 Remove a whole bunch of unused imports
Change-Id: I6759e5b6250c48cc0deb4b198b44c948c64c47d1
2012-01-13 13:55:38 -08:00
Lorin Hochstein d4a3962a2d Fix deprecation warnings
Fixed some warnings like this:

DeprecationWarning: docutils.nodes.Element.set_class deprecated; append to
Element['classes'] list attribute directly
  lists[i].set_class('todo_list')

Change-Id: I94e564f561f95a66e6e98767ccfaa78769b5c0f1
2011-11-24 10:54:21 -05:00
Eric Windisch 5f6a58c7c2 execvp: fix docs 2011-03-09 17:22:54 -05:00
Ed Leafe 68c9c89300 Completed first pass at converting all localized strings with multiple format substitutions. 2011-01-18 21:00:28 -05:00
jaypipes@gmail.com 56856ac110 Fix doc building endpoint for gettext. 2010-12-22 11:12:20 -05:00
root 1a020c2713 notes, and add code to enable sorted "..todo:: P[1-5] xyz" syntax 2010-11-12 09:25:01 -08:00
Todd Willey a3b6e0f358 Use the autodoc tools in the setup.py build_sphinx toolchain. 2010-11-07 17:53:39 -05:00
root dd505245c2 add in custom todo, and custom css 2010-11-05 12:49:42 -07:00