diff options
author | Campbell Barton <ideasman42@gmail.com> | 2021-05-17 10:56:18 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2021-05-17 11:02:56 +0300 |
commit | e3a76feeefa9ff7278a6f79fd5905f762462b485 (patch) | |
tree | cfdbacd42d8a6d1681b3358f80064f13777ff6ee | |
parent | 610c0ecc3b91a9d3f08fc83eac26bc75c3dfc92b (diff) |
Fix PyAPI doc generation error in 43369ca80e62aa80b951823d1c78abef58852014
Files without doc-strings were not included.
-rw-r--r-- | doc/python_api/sphinx_doc_gen.py | 9 |
1 files changed, 8 insertions, 1 deletions
diff --git a/doc/python_api/sphinx_doc_gen.py b/doc/python_api/sphinx_doc_gen.py index 8be194a58a2..107c233134e 100644 --- a/doc/python_api/sphinx_doc_gen.py +++ b/doc/python_api/sphinx_doc_gen.py @@ -545,6 +545,13 @@ def range_str(val): def example_extract_docstring(filepath): + ''' + Return (text, line_no, line_no_has_content) where: + - ``text`` is the doc-string text. + - ``line_no`` is the line the doc-string text ends. + - ``line_no_has_content`` when False, this file only contains a doc-string. + There is no need to include the remainder. + ''' file = open(filepath, "r", encoding="utf-8") line = file.readline() line_no = 0 @@ -553,7 +560,7 @@ def example_extract_docstring(filepath): line_no += 1 else: file.close() - return "", 0, False + return "", 0, True for line in file: line_no += 1 |