ilusha/blender
1
0
Fork 0
mirror of https://github.com/blender/blender synced 2026-09-29 04:37:17 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

PyDoc: fix error in recent example re-numbering

Browse source 
Error in [0] caused examples that didn't start at 0 to be ignored.

Simplify logic with iteration instead of recursion.

[0]: 0640836baa
This commit is contained in:
Campbell Barton 2026-02-13 14:46:04 +11:00
parent e8bdbfb8c4
commit 108755a79c
1 changed files with 30 additions and 30 deletions
Download patch file Download diff file Expand all files Collapse all files

60
doc/python_api/sphinx_doc_gen.py
View file

@ -392,7 +392,7 @@ EXTRA_SOURCE_FILES = (
# Examples.
EXAMPLES_DIR = os.path.abspath(os.path.join(SCRIPT_DIR, "examples"))
EXAMPLE_SET = set(f.removesuffix(".0.py") for f in os.listdir(EXAMPLES_DIR) if f.endswith(".0.py"))
EXAMPLE_SET = set(os.path.splitext(f)[0] for f in os.listdir(EXAMPLES_DIR) if f.endswith(".py"))
EXAMPLE_SET_USED = set()
# RST files directory.
@ -739,43 +739,43 @@ def title_string(text, heading_char, double=False):
return "{:s}\n{:s}\n\n".format(text, filler)
def write_example_ref(ident, fw, example_id, ext="py"):
if example_id in EXAMPLE_SET:
# Extract the comment.
filepath = os.path.join("..", "examples", "{:s}.0.{:s}".format(example_id, ext))
filepath_full = os.path.join(os.path.dirname(fw.__self__.name), filepath)
text, line_no, line_no_has_content = example_extract_docstring(filepath_full)
if text:
# Ensure a blank line, needed since in some cases the indentation doesn't match the previous line.
# which causes Sphinx not to warn about bad indentation.
fw("\n")
for line in text.split("\n"):
fw("{:s}\n".format((ident + line).rstrip()))
def write_example_ref_impl(ident, fw, example_id, ext):
# Extract the comment.
filepath = os.path.join("..", "examples", "{:s}.{:s}".format(example_id, ext))
filepath_full = os.path.join(os.path.dirname(fw.__self__.name), filepath)
text, line_no, line_no_has_content = example_extract_docstring(filepath_full)
if text:
# Ensure a blank line, needed since in some cases the indentation doesn't match the previous line.
# which causes Sphinx not to warn about bad indentation.
fw("\n")
for line in text.split("\n"):
fw("{:s}\n".format((ident + line).rstrip()))
# Some files only contain a doc-string.
if line_no_has_content:
fw("{:s}.. literalinclude:: {:s}\n".format(ident, filepath))
if line_no > 0:
fw("{:s} :lines: {:d}-\n".format(ident, line_no))
fw("\n")
EXAMPLE_SET_USED.add(example_id)
else:
if bpy.app.debug:
BPY_LOGGER.debug("\tskipping example: %s", example_id)
fw("\n")
# Support for numbered files `bpy.types.Operator` -> `bpy.types.Operator.1.py`.
i = 1
# Some files only contain a doc-string.
if line_no_has_content:
fw("{:s}.. literalinclude:: {:s}\n".format(ident, filepath))
if line_no > 0:
fw("{:s} :lines: {:d}-\n".format(ident, line_no))
fw("\n")
EXAMPLE_SET_USED.add(example_id)
def write_example_ref(ident, fw, example_id, ext="py"):
# Support for numbered files `bpy.types.Operator` -> `bpy.types.Operator.0.py`.
i = 0
while True:
example_id_num = "{:s}.{:d}".format(example_id, i)
if example_id_num in EXAMPLE_SET:
write_example_ref(ident, fw, example_id_num, ext)
i += 1
write_example_ref_impl(ident, fw, example_id_num, ext)
else:
break
# Allow numbers to start at 0 or 1,
# historically they started at 1, but now 0 is supported too.
if i > 0:
break
i += 1
def write_indented_lines(ident, fn, text, strip=True):