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
blender/doc/python_api/examples
History
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
..
aud.0.py PyDoc: number all examples to avoid conflicts when type checking 2026-02-12 00:51:02 +00:00
blf.0.py PyDoc: number all examples to avoid conflicts when type checking 2026-02-12 00:51:02 +00:00
blf.1.py PyDoc: various corrections to doc-strings and examples 2026-02-10 01:49:44 +00:00
bmesh.ops.1.py
bpy.app.driver_namespace.0.py PyDoc: number all examples to avoid conflicts when type checking 2026-02-12 00:51:02 +00:00
bpy.app.handlers.0.py PyDoc: number all examples to avoid conflicts when type checking 2026-02-12 00:51:02 +00:00
bpy.app.handlers.1.py
bpy.app.handlers.2.py PyDoc: use complete sentences in comments for templates & examples 2025-04-02 23:46:58 +00:00
bpy.app.timers.1.py
bpy.app.timers.2.py
bpy.app.timers.3.py
bpy.app.timers.4.py
bpy.app.translations.0.py PyDoc: number all examples to avoid conflicts when type checking 2026-02-12 00:51:02 +00:00
bpy.context.property.0.py PyDoc: number all examples to avoid conflicts when type checking 2026-02-12 00:51:02 +00:00
bpy.data.0.py PyDoc: number all examples to avoid conflicts when type checking 2026-02-12 00:51:02 +00:00
bpy.msgbus.1.py Cleanup: hyphenate the term data-blocks in strings/doc-strings 2025-08-08 08:47:13 +10:00
bpy.msgbus.2.py PyDoc: make examples self contained, resolve type warnings 2026-02-12 00:25:15 +00:00
bpy.msgbus.3.py PyDoc: make examples self contained, resolve type warnings 2026-02-12 00:25:15 +00:00
bpy.ops.0.py PyDoc: number all examples to avoid conflicts when type checking 2026-02-12 00:51:02 +00:00
bpy.ops.1.py Docs: correct context.temp_override example 2025-02-11 10:51:05 +11:00
bpy.ops.2.py PyDoc: use complete sentences in comments for templates & examples 2025-04-02 23:46:58 +00:00
bpy.ops.3.py
bpy.props.0.py PyDoc: number all examples to avoid conflicts when type checking 2026-02-12 00:51:02 +00:00
bpy.props.1.py PyDoc: various corrections to doc-strings and examples 2026-02-10 01:49:44 +00:00
bpy.props.2.py PyDoc: use complete sentences in comments for templates & examples 2025-04-02 23:46:58 +00:00
bpy.props.3.py
bpy.props.4.py
bpy.props.5.py PyDoc: various corrections to doc-strings and examples 2026-02-10 01:49:44 +00:00
bpy.types.ActionSlot.1.py Docs: Add Action Slot example code to PyAPI docs 2026-01-09 16:32:49 +01:00
bpy.types.ActionSlot.2.py PyDoc: make examples self contained, resolve type warnings 2026-02-12 00:25:15 +00:00
bpy.types.ActionSlot.3.py PyDoc: make examples self contained, resolve type warnings 2026-02-12 00:25:15 +00:00
bpy.types.ActionSlot.4.py PyDoc: make examples self contained, resolve type warnings 2026-02-12 00:25:15 +00:00
bpy.types.AddonPreferences.1.py Cleanup: replace references to "C" to C++ or the C-API 2025-03-26 17:23:33 +11:00
bpy.types.Attribute.0.py PyDoc: number all examples to avoid conflicts when type checking 2026-02-12 00:51:02 +00:00
bpy.types.BlendDataLibraries.load.0.py PyDoc: number all examples to avoid conflicts when type checking 2026-02-12 00:51:02 +00:00
bpy.types.BlendDataLibraries.write.0.py PyDoc: number all examples to avoid conflicts when type checking 2026-02-12 00:51:02 +00:00
bpy.types.Bone.convert_local_to_pose.0.py PyDoc: number all examples to avoid conflicts when type checking 2026-02-12 00:51:02 +00:00
bpy.types.bpy_prop_collection.foreach_get.0.py PyDoc: number all examples to avoid conflicts when type checking 2026-02-12 00:51:02 +00:00
bpy.types.bpy_prop_collection.foreach_set.0.py PyDoc: number all examples to avoid conflicts when type checking 2026-02-12 00:51:02 +00:00
bpy.types.bpy_struct.is_property_set.0.py PyDoc: number all examples to avoid conflicts when type checking 2026-02-12 00:51:02 +00:00
bpy.types.bpy_struct.keyframe_insert.0.py PyDoc: number all examples to avoid conflicts when type checking 2026-02-12 00:51:02 +00:00
bpy.types.bpy_struct.keyframe_insert.1.py
bpy.types.Context.temp_override.1.py
bpy.types.Context.temp_override.2.py Fix: PyDocs: typo fix in example 2025-08-12 17:20:04 +02:00
bpy.types.Context.temp_override.3.py
bpy.types.Context.temp_override.4.py PyAPI: support for context logging to suppress missing member access 2026-01-13 19:17:09 +11:00
bpy.types.Depsgraph.1.py Cleanup: spelling & repeated words in comments 2025-03-06 10:33:21 +11:00
bpy.types.Depsgraph.2.py
bpy.types.Depsgraph.3.py
bpy.types.Depsgraph.4.py Cleanup: spelling in build-files & docs 2025-01-31 15:22:50 +11:00
bpy.types.Depsgraph.5.py Cleanup: quiet check_spelling_* targets 2025-02-02 13:58:34 +11:00
bpy.types.Depsgraph.6.py PyDoc: use complete sentences in comments for templates & examples 2025-04-02 23:46:58 +00:00
bpy.types.Depsgraph.7.py Docs: Use reference links when possible when linking to other API 2024-03-29 22:54:12 -04:00
bpy.types.FileHandler.1.py PyDoc: correct use of back ticks for literal text 2025-08-22 15:10:29 +10:00
bpy.types.FileHandler.2.py PyDoc: correct use of back ticks for literal text 2025-08-22 15:10:29 +10:00
bpy.types.GeometrySet.0.py PyDoc: number all examples to avoid conflicts when type checking 2026-02-12 00:51:02 +00:00
bpy.types.HydraRenderEngine.0.py PyDoc: number all examples to avoid conflicts when type checking 2026-02-12 00:51:02 +00:00
bpy.types.ID.user_clear.1.py PyDoc: use complete sentences in comments for templates & examples 2025-04-02 23:46:58 +00:00
bpy.types.Image.0.py PyDoc: number all examples to avoid conflicts when type checking 2026-02-12 00:51:02 +00:00
bpy.types.InlineShaderNodes.0.py PyDoc: number all examples to avoid conflicts when type checking 2026-02-12 00:51:02 +00:00
bpy.types.KeyMaps.1.py Doc: add Python API example for KeyMaps add-on registration 2026-01-22 07:23:50 +00:00
bpy.types.Macro.0.py PyDoc: number all examples to avoid conflicts when type checking 2026-02-12 00:51:02 +00:00
bpy.types.Menu.0.py PyDoc: use type-hint syntax, add missing docs & some corrections 2026-02-12 20:41:34 +11:00
bpy.types.Menu.1.py Cleanup: UI: Standardize ellipsis for menu operators 2025-12-04 23:04:28 +01:00
bpy.types.Menu.2.py
bpy.types.Menu.3.py PyDoc: use complete sentences in comments for templates & examples 2025-04-02 23:46:58 +00:00
bpy.types.Menu.4.py Fix #150602: invalid string formatting in menu example 2025-11-30 08:40:23 +00:00
bpy.types.Mesh.0.py PyDoc: number all examples to avoid conflicts when type checking 2026-02-12 00:51:02 +00:00
bpy.types.NodeTree.0.py PyDoc: number all examples to avoid conflicts when type checking 2026-02-12 00:51:02 +00:00
bpy.types.Object.0.py PyDoc: number all examples to avoid conflicts when type checking 2026-02-12 00:51:02 +00:00
bpy.types.Operator.0.py PyDoc: number all examples to avoid conflicts when type checking 2026-02-12 00:51:02 +00:00
bpy.types.Operator.1.py Doc: Py API: Add more info about UNDO operator option. 2024-11-11 16:13:37 +01:00
bpy.types.Operator.2.py PyDoc: use complete sentences in comments for templates & examples 2025-04-02 23:46:58 +00:00
bpy.types.Operator.3.py PyDoc: use complete sentences in comments for templates & examples 2025-04-02 23:46:58 +00:00
bpy.types.Operator.4.py PyDoc: use complete sentences in comments for templates & examples 2025-04-02 23:46:58 +00:00
bpy.types.Operator.5.py PyDoc: use complete sentences in comments for templates & examples 2025-04-02 23:46:58 +00:00
bpy.types.Operator.6.py PyDoc: use complete sentences in comments for templates & examples 2025-04-02 23:46:58 +00:00
bpy.types.Operator.7.py PyDoc: use complete sentences in comments for templates & examples 2025-04-02 23:46:58 +00:00
bpy.types.Panel.0.py PyDoc: number all examples to avoid conflicts when type checking 2026-02-12 00:51:02 +00:00
bpy.types.Panel.1.py
bpy.types.Panel.2.py
bpy.types.PoseBone.bbone_segment_matrix.0.py PyDoc: number all examples to avoid conflicts when type checking 2026-02-12 00:51:02 +00:00
bpy.types.PropertyGroup.0.py PyDoc: number all examples to avoid conflicts when type checking 2026-02-12 00:51:02 +00:00
bpy.types.RenderEngine.1.py PyDoc: use complete sentences in comments for templates & examples 2025-04-02 23:46:58 +00:00
bpy.types.RenderEngine.2.py Fix #104061: RenderEngine Python example does not work in background mode 2024-06-14 15:47:49 +02:00
bpy.types.UIList.1.py UI/BPY: Remove grid layout for UI lists 2025-09-29 13:07:31 +02:00
bpy.types.UIList.2.py UI/BPY: Remove grid layout for UI lists 2025-09-29 13:07:31 +02:00
bpy.types.USDHook.0.py PyDoc: number all examples to avoid conflicts when type checking 2026-02-12 00:51:02 +00:00
bpy.types.WindowManager.fileselect_add.0.py PyDoc: number all examples to avoid conflicts when type checking 2026-02-12 00:51:02 +00:00
bpy.types.WindowManager.popup_menu.0.py PyDoc: number all examples to avoid conflicts when type checking 2026-02-12 00:51:02 +00:00
bpy.utils.register_cli_command.0.py PyDoc: number all examples to avoid conflicts when type checking 2026-02-12 00:51:02 +00:00
bpy.utils.register_cli_command.1.py Revert changes from main commits that were merged into blender-v4.1-release 2024-03-18 15:04:12 +01:00
gpu.1.py PyDoc: various corrections to doc-strings and examples 2026-02-10 01:49:44 +00:00
gpu.2.py
gpu.3.py Fix #139565: Update GPU polyline examples 2025-05-30 09:10:51 +02:00
gpu.4.py
gpu.5.py
gpu.6.py PyDoc: replace deprecated TRI_FAN with TRI_STRIP in GPU examples 2026-02-11 23:31:41 +00:00
gpu.7.py PyDoc: replace deprecated TRI_FAN with TRI_STRIP in GPU examples 2026-02-11 23:31:41 +00:00
gpu.8.py PyDoc: use complete sentences in comments for templates & examples 2025-04-02 23:46:58 +00:00
gpu.9.py
gpu.10.py PyDoc: make examples self contained, resolve type warnings 2026-02-12 00:25:15 +00:00
gpu.11.py PyDoc: replace deprecated TRI_FAN with TRI_STRIP in GPU examples 2026-02-11 23:31:41 +00:00
mathutils.0.py PyDoc: number all examples to avoid conflicts when type checking 2026-02-12 00:51:02 +00:00
mathutils.Color.0.py PyDoc: number all examples to avoid conflicts when type checking 2026-02-12 00:51:02 +00:00
mathutils.Euler.0.py PyDoc: number all examples to avoid conflicts when type checking 2026-02-12 00:51:02 +00:00
mathutils.kdtree.0.py PyDoc: number all examples to avoid conflicts when type checking 2026-02-12 00:51:02 +00:00
mathutils.Matrix.0.py PyDoc: number all examples to avoid conflicts when type checking 2026-02-12 00:51:02 +00:00
mathutils.Matrix.LocRotScale.0.py PyDoc: number all examples to avoid conflicts when type checking 2026-02-12 00:51:02 +00:00
mathutils.Quaternion.0.py PyDoc: number all examples to avoid conflicts when type checking 2026-02-12 00:51:02 +00:00
mathutils.Vector.0.py PyDoc: number all examples to avoid conflicts when type checking 2026-02-12 00:51:02 +00:00