Commit bd7e62f796fe951fd42c2edad56e252a0b7393c8 disabled the
autodoc_index_modules flag for building docs but it wasn't really
necessary, that change was just to get the module index out of the main
docs page.
We want to autodoc the modules so we can view the actual module index in
the tox -d docs build results, which also tells us if we have correct
ReST format in doc strings.
Notes
-----
1. Several doc string blocks have to be fixed as part of this to get
the docs tox job to pass.
2. A docstring in vhdutilsv2 is updated to remove the math directive
since that requires the sphinx.ext.pngmath extension which requires
latex and dvipng packages from the distro - which is overkill for
what the docstring was actually doing with the math directive.
3. We exclude autodoc for tests since we don't really care about
docstrings on unit tests.
4. We exclude the nova.wsgi.nova-* modules since those won't build with
autodoc since they can't be imported (there is no
nova/wsgi/__init__.py module). We could arguably add the __init__.py
but it's not really necessary for what those scripts are used for.
5. The sphinx.ext.ifconfig extension is removed since there are no docs
that use the ifconfig directive.
6. Update the developer docs to explicitly point out that graphviz must
be installed prior to running tox -e docs.
7. Hide doc/source/api/autoindex.rst from the toctree so that we don't
regress the point of commit bd7e62f796fe951fd42c2edad56e252a0b7393c8.
8. unused_docs and exclude_trees options are removed from conf.py since
they are deprecated in Sphinx 1.2.3:
https://github.com/sphinx-doc/sphinx/blob/1.2.3/sphinx/config.py#L54
9. Fix imports for moved libvirt volume options.
Closes-Bug: #1471934
Change-Id: I946e2f89f2c9fc70e870faaf84e4a8b0fc703344
The diagrams were hard to read and update. Replaced them with
simplified diagrams and tables. I used the content as is. I looks
inconsistent to me, but should now be easier to change.
Partially implements: blueprint devref-refresh-liberty
Change-Id: I707e1a6ab69ef44448b66e8be007307b5d73eb06
- Changes api to API to force build of all source files.
- Ensures tracking is consistent across all openstack.org web properties.
- Tracks only docs.openstack.org/developer/{{ project }} where
project name is taken from conf.py.
- Removes ability to build local without GA. If you have ideas
for how to build local without GA, please patch.
Change-Id: Ibb61e5c1668e6a0782daf91d4faf0950c5bf77d7
Partial-bug: 1441315
* Explain these docs are for trunk (copied from ironic)
* All the docs in this repo are meant to be developer docs, so having a
devref inside of the docs is redundant and just makes the docs more
complicated to navigate. Move everything out of the devref folder and
link to everything from main index.
* Move man pages into separate section. The man pages are pretty sparse
* right now, we should either make them useful or just delete them
* Remove dead docs from unused_docs list in doc/source/conf.py
* Shuffle docs landing page, move common referees to the top (API,
hypervisor support matrix), Add a introduction section and more. The
hope is the updated layout makes this document easier to navigate.
* Use maxdepth of 1
* Rename a few sections with what are hopefully better names
The next step is to prune out outdated documents and further cleanup
this page.
Change-Id: Iff453e47ccc902a0e72b1a5f6ce1ee939ff3a1a0
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
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 causes docs jobs to fail because we error out on warnings.
Change-Id: I71e941e2a639641a662a163c682eb86d51de42fb
Related-Bug: #1368910
Adds a websocket proxy that is compatible with Nova
serial ports.
Co-Authored-By: Vladan Popovic <vpopovic@redhat.com>
Co-Authored-By: Ian Wells <iawells@cisco.com>
Co-Authored-By: Sushma Korati <sushma_korati@persistent.co.in>
Partial-Implements: blueprint serial-ports
Change-Id: Ia944cb93945140e6341588063329a981f7e778f1
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
oslosphinx is now available as a replacement for oslo.sphinx that
won't conflict with oslo.config in virtual envs.
Change-Id: I7c116f816af895261e76af385ee3e9288e6fa70f
Closes-Bug: #1277168
Use the new oslo.sphinx version of the OpenStack doc
theme instead of copying it into this repo.
blueprint oslo.sphinx
Signed-off-by: Doug Hellmann <doug.hellmann@dreamhost.com>
Change-Id: I0bd91f7bb43f97b99051fed65b75fc05d5149cc8
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
Add nova-spicehtml5proxy which provides a websockets proxy,
equivalent to nova-novncproxy
Blueprint: libvirt-spice
Change-Id: I48be78c97bb7dd6635fd4bba476ef22701418ba1
Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
This adds a new service called "nova-conductor" which will provide
services for nova-compute, such as completing database updates and
handling long-running tasks.
Right now, this just adds a fraction of the database-related work
so that we can proceed with incremental changes to nova-compute.
For compatibility/flexibility, both LocalAPI and (RPC)API classes
are provided. Users concerned with performance or compatibility
who wish to maintain compute-node-local database accesses can
set the [conductor] use_local=True, which will mimic the legacy
behavior.
DocImpact
Change-Id: Ib81d879f40b7daceeffad5af0631c7db68168661
This removes the majority of the nova-volume code from the codebase.
It updates relevent config options to default to cinder. It updates a
number of existing tests that were depending on code that was removed.
A few things still need to be removed:
* volume/driver.py & volume/iscsi.py
These files are used by the libvirt volume driver tests. These
tests should be updated to mock the relevant calls.
* scheduler/simple.py & scheduler/multi.py
These files should no longer be necessary so they can be removed
in a subsequent patch
* exception.py cleanup
Once the above files are removed there are a number of unused
exceptions which can be removed
* database calls and database tables
The database calls have not been removed and the tables have not
been dropped. This can be done in a separate migration
* additional config options and nova.conf.sample
There may be a few extra config options that can be removed and the
conf sample can be regenerated
Implements bp delete-nova-volume
Change-Id: I0b540e54dbabd26901a7530035a38583bb521fda
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
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
Commit 29df6cd70 renamed novamanage to nova-manage but did
not update doc/source/conf.py accordingly causing build_sphinx
failures.
Also removes a stale conf.py backup created some time ago
Change-Id: Ia00b6d88eab90e0e77992375d7ccc7036c9d5f34
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
blueprint sphinx-doc-cleanup
bug 945160
- Correct parameter declarations, list formatting, cross-references, etc.
- We don't need "let" in generate_autodoc_index.sh since we aren't doing math.
- Change conf.py to not prefix class and function names with full namespace
in generated output to save width on the screen.
Change-Id: I9adc8681951913fd291d03e7142146e9d46841df
