diff options
author | Aaron Carlisle <carlisle.b3d@gmail.com> | 2022-11-04 06:36:12 +0300 |
---|---|---|
committer | Aaron Carlisle <carlisle.b3d@gmail.com> | 2022-11-04 06:36:12 +0300 |
commit | eb8155ebcde28fe924dfae464a1b09bd3d16edfd (patch) | |
tree | c5d077a34d1bd320f2ef0c8e858d23895d7a84d3 | |
parent | c5dde1c345438d48a83c984514c735ab89548ac5 (diff) |
PyDoc: Make rst files more readable
This commit reduces the amount of white space generated and keeps parameter documentation of a single line.
This makes the resulting rst files easier to read in the case of debugging.
This was useful while looking into T97464
-rw-r--r-- | doc/python_api/sphinx_doc_gen.py | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/python_api/sphinx_doc_gen.py b/doc/python_api/sphinx_doc_gen.py index 7b5f13177ef..f51ab8d6591 100644 --- a/doc/python_api/sphinx_doc_gen.py +++ b/doc/python_api/sphinx_doc_gen.py @@ -1459,15 +1459,15 @@ def pyrna2sphinx(basepath): # If the link has been written, no need to inline the enum items. enum_text = "" if enum_descr_override else pyrna_enum2sphinx(prop) if prop.name or prop.description or enum_text: - fw(ident + ":%s%s:\n\n" % (id_name, identifier)) + fw(ident + ":%s%s: " % (id_name, identifier)) if prop.name or prop.description: - fw(indent(", ".join(val for val in (prop.name, prop.description) if val), ident + " ") + "\n\n") + fw(", ".join(val for val in (prop.name, prop.description.replace("\n", "")) if val) + "\n") # Special exception, can't use generic code here for enums. if enum_text: - write_indented_lines(ident + " ", fw, enum_text) fw("\n") + write_indented_lines(ident + " ", fw, enum_text) del enum_text # end enum exception |