nova/nova/objects
Matt Riedemann 8b24bf766d Set autodoc_index_modules=True so tox -e docs builds module docs again
Commit bd7e62f796 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 bd7e62f796.
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
2015-07-30 17:11:47 -07:00
..
__init__.py Add HostMapping object 2015-07-10 07:30:28 +00:00
agent.py Begin the transition to an explicit object registry 2015-06-08 07:12:34 -07:00
aggregate.py Begin the transition to an explicit object registry 2015-06-08 07:12:34 -07:00
bandwidth_usage.py Merge "Map uuid db field to instance_uuid in BandwidthUsage object" 2015-06-10 18:24:59 +00:00
base.py Set autodoc_index_modules=True so tox -e docs builds module docs again 2015-07-30 17:11:47 -07:00
block_device.py Added method exists to the Tag object 2015-07-09 09:00:39 +03:00
cell_mapping.py Begin the transition to an explicit object registry 2015-06-08 07:12:34 -07:00
compute_node.py libvirt: rename parallels driver to virtuozzo 2015-07-29 18:40:12 +03:00
dns_domain.py Begin the transition to an explicit object registry 2015-06-08 07:12:34 -07:00
ec2.py Begin the transition to an explicit object registry 2015-06-08 07:12:34 -07:00
external_event.py Begin the transition to an explicit object registry 2015-06-08 07:12:34 -07:00
fields.py Add DictOfListOfStrings type of field 2015-07-28 17:00:54 +02:00
fixed_ip.py Added method exists to the Tag object 2015-07-09 09:00:39 +03:00
flavor.py Merge "Object: Fix incorrect parameter set in flavor save_extra_specs" 2015-06-10 15:28:51 +00:00
floating_ip.py Added method exists to the Tag object 2015-07-09 09:00:39 +03:00
host_mapping.py objects: Don't import CellMapping from the objects module 2015-07-16 19:30:54 +01:00
hv_spec.py libvirt: rename parallels driver to virtuozzo 2015-07-29 18:40:12 +03:00
image_meta.py Set autodoc_index_modules=True so tox -e docs builds module docs again 2015-07-30 17:11:47 -07:00
instance.py Merge "objects: send PciDeviceList 1.2 to all code that can handle it" 2015-07-30 13:21:16 +00:00
instance_action.py Begin the transition to an explicit object registry 2015-06-08 07:12:34 -07:00
instance_fault.py Begin the transition to an explicit object registry 2015-06-08 07:12:34 -07:00
instance_group.py Begin the transition to an explicit object registry 2015-06-08 07:12:34 -07:00
instance_info_cache.py Merge "Send Instance object to cells instance_update_at_top" 2015-06-12 01:33:13 +00:00
instance_mapping.py Begin the transition to an explicit object registry 2015-06-08 07:12:34 -07:00
instance_numa_topology.py Enable python34 tests for nova/tests/unit/objects/test*.py 2015-07-01 20:29:42 +00:00
instance_pci_requests.py Begin the transition to an explicit object registry 2015-06-08 07:12:34 -07:00
keypair.py Begin the transition to an explicit object registry 2015-06-08 07:12:34 -07:00
migration.py Fix incorrect enum in Migration object and DB model 2015-07-06 15:38:54 -07:00
monitor_metric.py Adds MonitorMetric object 2015-07-06 09:47:24 -04:00
network.py Begin the transition to an explicit object registry 2015-06-08 07:12:34 -07:00
network_request.py Begin the transition to an explicit object registry 2015-06-08 07:12:34 -07:00
numa.py Begin the transition to an explicit object registry 2015-06-08 07:12:34 -07:00
pci_device.py Fix the incorrect PciDeviceList version number 2015-07-16 16:07:40 -07:00
pci_device_pool.py Begin the transition to an explicit object registry 2015-06-08 07:12:34 -07:00
quotas.py Begin the transition to an explicit object registry 2015-06-08 07:12:34 -07:00
security_group.py Begin the transition to an explicit object registry 2015-06-08 07:12:34 -07:00
security_group_rule.py Begin the transition to an explicit object registry 2015-06-08 07:12:34 -07:00
service.py libvirt: rename parallels driver to virtuozzo 2015-07-29 18:40:12 +03:00
tag.py Added method exists to the Tag object 2015-07-09 09:00:39 +03:00
task_log.py Add a TaskLog object 2015-06-15 12:30:52 +02:00
vcpu_model.py Begin the transition to an explicit object registry 2015-06-08 07:12:34 -07:00
virt_cpu_topology.py Begin the transition to an explicit object registry 2015-06-08 07:12:34 -07:00
virtual_interface.py Begin the transition to an explicit object registry 2015-06-08 07:12:34 -07:00