From a0f54cc8d4c1a3d3a6964cd5f4ddd82132d28f67 Mon Sep 17 00:00:00 2001 From: "Daniel P. Berrange" Date: Fri, 21 Nov 2014 14:57:07 +0000 Subject: [PATCH] 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 --- doc/source/conf.py | 3 ++- doc/source/index.rst | 1 + 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index 3083cd163..257db7492 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -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. diff --git a/doc/source/index.rst b/doc/source/index.rst index fdf978bb6..af1c1567b 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -48,6 +48,7 @@ Developer Docs devref/index man/index + support-matrix API Extensions ==============