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
Don't list entire api/autoindex under Developer Docs, we already have a
model index link at the bottom of the page, showing the entire
autoindex on the home page is makes the page overwhelming.
Change-Id: I25c5b50412881b55aa745ce3da2c22466e879fcf
By setting this pbr option in setup.cfg, the doc build will fail in case
of any warnings or errors occur during the build process.
Closes-Bug: #1351350
Change-Id: Id4858062d2aaa4c2fe5b597e40e4e8947f544a4d
The doc todo list didn't actually work, so remove it. Also, the
documentation is not written by Anso Labs quite so much anymore.
Change-Id: I746a26505d331ab55565e952a1a46425458b1412
blueprint sphinx-doc-cleanup
bug 944385
- Fix formatting and markup issues that produce error messages
- Update TOC lists for missing/new files
- Fix a few links
- Update instructions with dependencies for building the documentation
- Updated base on review comments from oubiwann to fix trailing whitespace in modified files
Change-Id: I589152bfab9c543d2b11fa8bed2344259aa90675
This patch fixes the docs so that the API extensions documentation gets
included. In passing, also update the API extensions index to include
an extension that was not listed.
Change-Id: Ia16cab2b29bbc121d940dc4ed9f033340935cde8
Daniel P. Berrange