blender/doc/python_api
Campbell Barton 998fe01e28 PyDoc: use type-hint syntax, add missing docs & some corrections
sphinx_doc_gen.py:
- Add _PRIVATE_ATTR_INCLUDE so underscore-prefixed types can be
  selectively included in API docs (needed to reference return values).
- Add :return:/:rtype: for operators.
- Fix context type entries (AnnotationLayer, FluidModifier, Curves).

bpy.props:
- Add :return:/:rtype: for property declaration functions.

gpu:
- Expose MatrixStackContext and OffScreenStackContext as documented
  gpu.types so :rtype: references resolve.

bmesh.ops:
- Use Sequence[float] for vector input params.
- Add default_value for single-element BMO_OP_SLOT_ELEMENT_BUF slots.

bpy.types:
- Convert `tuple of X` to `tuple[X, ...]` and `list of X` to `list[X]`.
- Add :return:/:rtype: to Context.path_resolve and Operator.as_keywords.
- Fix Menu example link reference.

bpy_extras:
- Convert Python type annotations to :param:/:type:/:rtype:,
  add missing doc-strings.

bpy.app.handlers:
- Add :type: with callable signatures.
- Fix depsgraph_update handler description
  (the second argument is optional).
- Fix missing argument descriptions for render and undo/redo handlers.

bpy.context
- Use type hints for for property listing.

mathutils.kdtree:
- Fix doc-string syntax.
- Clarify that the size is an upper limit.

Various minor corrections to other modules.
2026-02-12 20:41:34 +11:00
..
examples PyDoc: use type-hint syntax, add missing docs & some corrections 2026-02-12 20:41:34 +11:00
rst PyDoc: number all examples to avoid conflicts when type checking 2026-02-12 00:51:02 +00:00
static Cleanup: use ASCII comments, add tailing newline 2025-10-23 13:58:16 +11:00
templates Cleanup: strip trailing space for TOML,HTML & XML 2025-02-02 13:58:34 +11:00
conf.py PyDoc: support disabling online access when building the API docs 2025-04-04 10:14:21 +11:00
requirements.txt PyDocs: Update Sphinx / Theme 2025-08-09 19:06:34 -04:00
rst_from_bmesh_opdefines.py PyDoc: use type-hint syntax, add missing docs & some corrections 2026-02-12 20:41:34 +11:00
sphinx_changelog_gen.py PyAPI: make internal modules explicitly "private" 2025-10-13 09:35:09 +00:00
sphinx_doc_gen.py PyDoc: use type-hint syntax, add missing docs & some corrections 2026-02-12 20:41:34 +11:00
sphinx_doc_gen_monkeypatch.py PyDocs: Fix broken type section 2025-01-25 20:44:37 -05:00