blender/doc/python_api/examples
Campbell Barton 03975acb55 Doc: add Python API example for KeyMaps add-on registration
Add an example with some notes on keymap usage, targeted at add-on
developers.

- Avoid pitfalls, add-on developers sometimes incorrectly modify user
  keymaps directly, which persists after the add-on is disabled and
  interferes with user preferences.
- Documents subtle/non-obvious requirements.
- Mention edge case regarding modal operator key-maps.

Ref !153111
2026-01-22 07:23:50 +00:00
..
aud.py PyDoc: use complete sentences in comments for templates & examples 2025-04-02 23:46:58 +00:00
blf.1.py PyAPI: add blf.bind_imbuf(..) context manager 2025-03-15 11:00:51 +11:00
blf.py PyDoc: use complete sentences in comments for templates & examples 2025-04-02 23:46:58 +00:00
bmesh.ops.1.py
bpy.app.driver_namespace.py
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.handlers.py
bpy.app.timers.1.py
bpy.app.timers.2.py
bpy.app.timers.3.py
bpy.app.timers.4.py
bpy.app.translations.py Cleanup: spelling in comments, strings (make check_spelling_*) 2025-05-06 00:18:39 +00:00
bpy.context.property.py
bpy.data.py PyDoc: use complete sentences in comments for templates & examples 2025-04-02 23:46:58 +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
bpy.msgbus.3.py
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.ops.py Fix: PyDocs: bpy.ops document behavior on error reports 2025-05-08 06:58:34 +02:00
bpy.props.1.py Fix Python: broken format string in API docs 2025-04-14 11:38:43 +02: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 Cleanup: fix typos in doc subdirectory 2025-09-06 08:03:16 +02:00
bpy.props.py Cleanup: replace references to "C" to C++ or the C-API 2025-03-26 17:23:33 +11: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 Docs: Add Action Slot example code to PyAPI docs 2026-01-09 16:32:49 +01:00
bpy.types.ActionSlot.3.py Docs: Add Action Slot example code to PyAPI docs 2026-01-09 16:32:49 +01:00
bpy.types.ActionSlot.4.py Docs: Add Action Slot example code to PyAPI docs 2026-01-09 16:32:49 +01: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.py
bpy.types.BlendDataLibraries.load.py Cleanup: naming & reduce declaration scope in the PyAPI for lib loading 2025-08-02 02:10:59 +00:00
bpy.types.BlendDataLibraries.write.py PyDoc: use complete sentences in comments for templates & examples 2025-04-02 23:46:58 +00:00
bpy.types.Bone.convert_local_to_pose.py PyDoc: use complete sentences in comments for templates & examples 2025-04-02 23:46:58 +00:00
bpy.types.bpy_prop_collection.foreach_get.py PyDoc: use complete sentences in comments for templates & examples 2025-04-02 23:46:58 +00:00
bpy.types.bpy_prop_collection.foreach_set.py PyDoc: use complete sentences in comments for templates & examples 2025-04-02 23:46:58 +00:00
bpy.types.bpy_struct.is_property_set.py
bpy.types.bpy_struct.keyframe_insert.1.py
bpy.types.bpy_struct.keyframe_insert.py PyDoc: use complete sentences in comments for templates & examples 2025-04-02 23:46:58 +00:00
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
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.py Python: Geometry: create GeometrySet wrapper for Python 2025-03-28 22:40:01 +01:00
bpy.types.HydraRenderEngine.py PyDoc: use complete sentences in comments for templates & examples 2025-04-02 23:46:58 +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.py
bpy.types.InlineShaderNodes.py Shader Nodes: add Python API for inlined shader nodes 2025-09-11 06:08:30 +02: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.py Cleanup: Format 2025-08-09 19:01:39 -04: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.Menu.py PyDoc: use complete sentences in comments for templates & examples 2025-04-02 23:46:58 +00:00
bpy.types.Mesh.py PyDoc: use complete sentences in comments for templates & examples 2025-04-02 23:46:58 +00:00
bpy.types.NodeTree.py
bpy.types.Object.py PyDoc: use complete sentences in comments for templates & examples 2025-04-02 23:46:58 +00:00
bpy.types.Operator.1.py
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.Operator.py Cleanup: replace references to "C" to C++ or the C-API 2025-03-26 17:23:33 +11:00
bpy.types.Panel.1.py
bpy.types.Panel.2.py
bpy.types.Panel.py Cleanup: replace references to "C" to C++ or the C-API 2025-03-26 17:23:33 +11:00
bpy.types.PoseBone.bbone_segment_matrix.py PyDoc: use complete sentences in comments for templates & examples 2025-04-02 23:46:58 +00:00
bpy.types.PropertyGroup.py PyDoc: use complete sentences in comments for templates & examples 2025-04-02 23:46:58 +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
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.py Fix #151742: Docs: Fix Typo in bpy.types.USDHook code 2025-12-18 18:36:25 +01:00
bpy.types.WindowManager.fileselect_add.py Docs: add warning regarding operators that use the file selector 2025-04-25 16:24:24 +10:00
bpy.types.WindowManager.popup_menu.py
bpy.utils.register_cli_command.1.py
bpy.utils.register_cli_command.py
gpu.1.py Fix #139565: Update GPU polyline examples 2025-05-30 09:10:51 +02: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 Fix #147618: PyGPU incorrect colors when drawing images 2025-10-16 19:12:16 +02:00
gpu.7.py PyDoc: use complete sentences in comments for templates & examples 2025-04-02 23:46:58 +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
gpu.11.py PyDoc: use complete sentences in comments for templates & examples 2025-04-02 23:46:58 +00:00
mathutils.Color.py PyDoc: include buffer access in examples, cleanup 2025-08-16 17:39:35 +10:00
mathutils.Euler.py PyDoc: include buffer access in examples, cleanup 2025-08-16 17:39:35 +10:00
mathutils.kdtree.py PyDoc: use complete sentences in comments for templates & examples 2025-04-02 23:46:58 +00:00
mathutils.Matrix.LocRotScale.py
mathutils.Matrix.py PyDoc: include buffer access in examples, cleanup 2025-08-16 17:39:35 +10:00
mathutils.py
mathutils.Quaternion.py PyDoc: include buffer access in examples, cleanup 2025-08-16 17:39:35 +10:00
mathutils.Vector.py PyDoc: include buffer access in examples, cleanup 2025-08-16 17:39:35 +10:00