openstack
/
python-heatclient
Code Issues Proposed changes

Merge "Improve titles of generated API documentation"

This commit is contained in:
Zuul 2018-06-04 09:48:42 +00:00 committed by Gerrit Code Review
parent b169493c57 bf2b57a92b
commit 83d102537e
1 changed files with 10 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
doc/source/ext/gen_ref.py
View File

@ -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"})