griefith/test
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Docs: Python: Use headings instead of rubrics

Browse Source 
This allows these headings to show under "On this page".
This commit is contained in:
Aaron Carlisle
2024-03-26 01:48:32 -04:00
parent 7d29f25ee1
commit 3b3a6ccecd
1 changed files with 3 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
doc/python_api/sphinx_doc_gen.py
View File

@@ -1712,7 +1712,7 @@ def pyrna2sphinx(basepath):
lines.append(" * :class:`%s.%s`\n" % (base.identifier, identifier))
if lines:
fw(".. rubric:: Inherited Properties\n\n")
fw(title_string("Inherited Properties", "-"))
fw(".. hlist::\n")
fw(" :columns: 2\n\n")
@@ -1738,7 +1738,7 @@ def pyrna2sphinx(basepath):
lines.append(" * :class:`%s.%s`\n" % (base.identifier, identifier))
if lines:
fw(".. rubric:: Inherited Functions\n\n")
fw(title_string("Inherited Functions", "-"))
fw(".. hlist::\n")
fw(" :columns: 2\n\n")
@@ -1750,8 +1750,7 @@ def pyrna2sphinx(basepath):
del lines[:]
if struct.references:
# use this otherwise it gets in the index for a normal heading.
fw(".. rubric:: References\n\n")
fw(title_string("References", "-"))
fw(".. hlist::\n")
fw(" :columns: 2\n\n")
@@ -2238,7 +2237,6 @@ def write_rst_enum_items(basepath, key, key_no_prefix, enum_items):
fw(".. _%s:\n\n" % key)
fw(title_string(key_no_prefix.replace("_", " ").title(), "#"))
# fw(".. rubric:: %s\n\n" % key_no_prefix.replace("_", " ").title())
for item in enum_items:
identifier = item.identifier