openstack/python-novaclient
Code Issues Proposed changes

Blacklist rather than whitelist autodoc modules

Browse Source 
Autogenerate the nova client python API module list rather than having
to remember to add new modules; use exclude to blacklist modules that
shouldn't be included in autodoc.

Change-Id: I051a7094f3b536f1e9a939af87e3fc89554fb375
This commit is contained in:
Diana Clarke 2016-12-29 14:33:37 -06:00
parent 084b0abb75
commit e8e39ed343
1 changed files with 10 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
doc/source/conf.py
View File

@ -70,18 +70,17 @@ def gen_ref(ver, title, names):
"signs": "=" * len(name), "signs": "=" * len(name),
"pkg": pkg, "name": name}) "pkg": pkg, "name": name})
def get_module_names():
names = os.listdir(os.path.join(ROOT, 'novaclient', 'v2'))
exclude = ['shell.py', '__init__.py']
for name in names:
if name.endswith('.py') and name not in exclude:
yield name.strip('.py')
gen_ref(None, "Exceptions", ["exceptions"]) gen_ref(None, "Exceptions", ["exceptions"])
gen_ref("v2", "Version 1.1, Version 2 API", gen_ref("v2", "Version 2 API", sorted(get_module_names()))
["agents", "aggregates", "assisted_volume_snapshots",
"availability_zones", "cells", "certs", "client", "cloudpipe",
"fixed_ips", "flavor_access", "flavors", "floating_ip_dns",
"floating_ip_pools", "floating_ips", "floating_ips_bulk", "fping",
"hosts", "hypervisors", "images", "instance_action", "keypairs",
"limits", "list_extensions", "migrations", "networks",
"quota_classes", "quotas", "security_group_default_rules",
"security_group_rules", "security_groups", "server_external_events",
"server_groups", "server_migrations", "servers", "services", "usage",
"versions", "virtual_interfaces", "volumes"])
# -- General configuration ---------------------------------------------------- # -- General configuration ----------------------------------------------------