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
This commit is contained in:
Daniel P. Berrange
2014-11-21 14:57:07 +00:00
parent 1c608e40fc
commit a0f54cc8d4
2 changed files with 3 additions and 1 deletions

View File

@ -34,6 +34,7 @@ extensions = ['sphinx.ext.autodoc',
'sphinx.ext.ifconfig',
'sphinx.ext.graphviz',
'oslosphinx',
"ext.support_matrix",
]
todo_include_todos = True
@ -195,7 +196,7 @@ man_pages = [
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
#html_static_path = ['_static']
html_static_path = ['_static']
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.

View File

@ -48,6 +48,7 @@ Developer Docs
devref/index
man/index
support-matrix
API Extensions
==============