diff options
| author | Zuul <zuul@review.openstack.org> | 2018-06-04 09:48:42 +0000 |
|---|---|---|
| committer | Gerrit Code Review <review@openstack.org> | 2018-06-04 09:48:42 +0000 |
| commit | 83d102537e609ef0803649bb73c31e72d3c9aa40 (patch) | |
| tree | 736bdc59accc986f7eae3d4ab054723adbc92a15 /doc | |
| parent | b169493c57b60231d36f9fb65ecf345778546756 (diff) | |
| parent | bf2b57a92b338899e29bdfd62bb74a456da10ee8 (diff) | |
| download | python-heatclient-83d102537e609ef0803649bb73c31e72d3c9aa40.tar.gz | |
Merge "Improve titles of generated API documentation"
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/ext/gen_ref.py | 16 |
1 files changed, 10 insertions, 6 deletions
diff --git a/doc/source/ext/gen_ref.py b/doc/source/ext/gen_ref.py index 15ff818..cbe936b 100644 --- a/doc/source/ext/gen_ref.py +++ b/doc/source/ext/gen_ref.py @@ -37,7 +37,7 @@ def gen_ref(ver, title, names): ".. toctree::\n" " :maxdepth: 1\n" "\n") % {"title": title, "signs": "=" * len(title)}) - for name in names: + for name, sec_title in names.items(): idx.write(" %s\n" % name) rstpath = os.path.join(refdir, "%s.rst" % name) with open(rstpath, "w") as rst: @@ -49,11 +49,15 @@ def gen_ref(ver, title, names): " :undoc-members:\n" " :show-inheritance:\n" " :noindex:\n") - % {"title": name.capitalize(), - "signs": "=" * len(name), + % {"title": sec_title, + "signs": "=" * len(sec_title), "pkg": pkg, "name": name}) -gen_ref("", "Client Reference", ["client", "exc"]) +gen_ref("", "Client Reference", {"client": "Client", "exc": "Exceptions"}) gen_ref("v1", "Version 1 API Reference", - ["stacks", "resources", "events", "actions", - "software_configs", "software_deployments"]) + {"stacks": "Stacks", + "resources": "Resources", + "events": "Events", + "actions": "Actions", + "software_configs": "Software Configs", + "software_deployments": "Software Deployments"}) |