Cleanup: API docs
authorCampbell Barton <ideasman42@gmail.com>
Tue, 8 Sep 2015 04:30:05 +0000 (14:30 +1000)
committerCampbell Barton <ideasman42@gmail.com>
Tue, 8 Sep 2015 09:42:58 +0000 (19:42 +1000)
21 files changed:
doc/python_api/examples/aud.py
doc/python_api/examples/bge.texture.1.py
doc/python_api/examples/bpy.app.handlers.py
doc/python_api/examples/bpy.ops.1.py
doc/python_api/examples/bpy.ops.py
doc/python_api/examples/bpy.types.AddonPreferences.1.py
doc/python_api/examples/bpy.types.Menu.1.py
doc/python_api/examples/bpy.types.Menu.2.py
doc/python_api/examples/bpy.types.Menu.py
doc/python_api/examples/bpy.types.Mesh.py
doc/python_api/examples/bpy.types.NodeTree.py
doc/python_api/examples/bpy.types.Object.py
doc/python_api/examples/bpy.types.Operator.1.py
doc/python_api/examples/bpy.types.Operator.2.py
doc/python_api/examples/bpy.types.Operator.3.py
doc/python_api/examples/bpy.types.Operator.4.py
doc/python_api/examples/bpy.types.Operator.5.py
doc/python_api/examples/bpy.types.Operator.py
doc/python_api/examples/bpy.types.Panel.1.py
doc/python_api/examples/bpy.types.Panel.py
doc/python_api/examples/bpy.types.UIList.2.py

index 2c74d6a0eb196b3ded895c35d12b4828cd73fa2a..bbe97168efea7d03d5bd8b618093d9dde4576ba2 100644 (file)
@@ -1,6 +1,7 @@
 """
 Basic Sound Playback
 ++++++++++++++++++++
+
 This script shows how to use the classes: :class:`Device`, :class:`Factory` and
 :class:`Handle`.
 """
index bee1f251afae2bc360f94f1c767251973e2bcc57..732c786c667bdf33eb4d5a7f34707a2ebfd65791 100644 (file)
@@ -1,6 +1,7 @@
 """
 Texture Replacement
 +++++++++++++++++++
+
 Example of how to replace a texture in game with an external image.
 ``createTexture()`` and ``removeTexture()`` are to be called from a
 module Python Controller.
index 57b209e15f02f6685e188dfebb3c5f4571d5135c..078f9df77f2e21630d071057bb38eaf933bcf676 100644 (file)
@@ -1,6 +1,7 @@
 """
 Basic Handler Example
 +++++++++++++++++++++
+
 This script shows the most simple example of adding a handler.
 """
 
index a00dbdafb9048d2efc2e793cca16538c1121006e..b4137e5c74050a3bcbc54dbcd75a704b8c7784c1 100644 (file)
@@ -7,8 +7,9 @@ act on specified rather than the selected or active data, or to execute an
 operator in the different part of the user interface.
 
 The context overrides are passed as a dictionary, with keys matching the context
-member names in bpy.context. For example to override bpy.context.active_object,
-you would pass {'active_object': object}.
+member names in bpy.context.
+For example to override ``bpy.context.active_object``,
+you would pass ``{'active_object': object}``.
 """
 
 # remove all objects in scene rather than the selected ones
index 9964ad915bf6e67e7ae15df3f2454047a62390ba..76c494ad4f59a7fbc2b1d88ff17a732768b56265 100644 (file)
@@ -3,21 +3,21 @@ Calling Operators
 -----------------
 
 Provides python access to calling operators, this includes operators written in
-C, Python or Macros.
+C, Python or macros.
 
 Only keyword arguments can be used to pass operator properties.
 
-Operators don't have return values as you might expect, instead they return a
-set() which is made up of: {'RUNNING_MODAL', 'CANCELLED', 'FINISHED',
-'PASS_THROUGH'}.
-Common return values are {'FINISHED'} and {'CANCELLED'}.
+Operators don't have return values as you might expect,
+instead they return a set() which is made up of:
+``{'RUNNING_MODAL', 'CANCELLED', 'FINISHED', 'PASS_THROUGH'}``.
+Common return values are ``{'FINISHED'}`` and ``{'CANCELLED'}``.
 
 
-Calling an operator in the wrong context will raise a RuntimeError,
+Calling an operator in the wrong context will raise a ``RuntimeError``,
 there is a poll() method to avoid this problem.
 
-Note that the operator ID (bl_idname) in this example is 'mesh.subdivide',
-'bpy.ops' is just the access path for python.
+Note that the operator ID (bl_idname) in this example is ``mesh.subdivide``,
+``bpy.ops`` is just the access path for python.
 
 
 Keywords and Positional Arguments
@@ -32,9 +32,9 @@ There are 3 optional positional arguments (documented in detail below).
 
    bpy.ops.test.operator(override_context, execution_context, undo)
 
-* override_context - dict type
-* execution_context - string (enum)
-* undo - boolean
+- override_context - ``dict`` type.
+- execution_context - ``str`` (enum).
+- undo - ``bool`` type.
 
 
 Each of these arguments is optional, but must be given in the order above.
index 73f90acb3fa9036a0ab9cf5c37b99ca5a150dcb3..7a065dbf6a5ff409f705f4af58da05693f11fa14 100644 (file)
@@ -8,7 +8,8 @@ bl_info = {
     "warning": "",
     "wiki_url": "",
     "tracker_url": "",
-    "category": "Object"}
+    "category": "Object",
+    }
 
 
 import bpy
index e82bf398e35662160c6f3b10e8795ff05eeb82b3..8ccc1123c35c6ef15959b4d9d3f20cd71d0f5dfc 100644 (file)
@@ -1,6 +1,7 @@
 """
 Submenus
 ++++++++
+
 This menu demonstrates some different functions.
 """
 import bpy
index 26409f12f45a701703b34719a3bda56ff30f572e..86288b5b1c5a107de76fda665a7247ce107ba5e4 100644 (file)
@@ -1,6 +1,7 @@
 """
 Extending Menus
 +++++++++++++++
+
 When creating menus for addons you can't reference menus in Blender's default
 scripts.
 Instead, the addon can add menu items to existing menus.
index e10e44f108e3596c17b79abdc685249400322582..c21624440556325db24e765eadff3772db3111a7 100644 (file)
@@ -1,6 +1,7 @@
 """
 Basic Menu Example
 ++++++++++++++++++
+
 Here is an example of a simple menu. Menus differ from panels in that they must
 reference from a header, panel or another menu.
 
index 19ccd177d64915cd056a48ce20adc1140d85efc4..68cc42ec6bf1a03789c9d615c0070d4e69a9f845 100644 (file)
@@ -7,10 +7,10 @@ for more flexible mesh editing from python see :mod:`bmesh`.
 
 Blender stores 4 main arrays to define mesh geometry.
 
-* :class:`Mesh.vertices` (3 points in space)
-* :class:`Mesh.edges` (reference 2 vertices)
-* :class:`Mesh.loops` (reference a single vertex and edge)
-* :class:`Mesh.polygons`: (reference a range of loops)
+- :class:`Mesh.vertices` (3 points in space)
+- :class:`Mesh.edges` (reference 2 vertices)
+- :class:`Mesh.loops` (reference a single vertex and edge)
+- :class:`Mesh.polygons`: (reference a range of loops)
 
 
 Each polygon reference a slice in the loop array, this way, polygons do not store vertices or corner data such as UV's directly,
index 401b3a01ae0d4cdf574944a0fb5d47acf2d9fa25..da2986636ea859bbab2240340695e655a7f495d7 100644 (file)
@@ -1,6 +1,7 @@
 """
 Poll Function
 +++++++++++++++
+
 The :class:`NodeTree.poll` function determines if a node tree is visible
 in the given context (similar to how :class:`Panel.poll`
 and :class:`Menu.poll` define visibility). If it returns False,
index 2ddce248a5bb23fb865a79eb802db15dc95a71e9..90c50bcfad702479c21ef3f972aff85fc2be100a 100644 (file)
@@ -1,6 +1,7 @@
 """
 Basic Object Operations Example
 +++++++++++++++++++++++++++++++
+
 This script demonstrates basic operations on object like creating new
 object, placing it into scene, selecting it and making it active.
 """
index f007cdfa0a72982153aa2cd2b8e1f6ede12bbf3f..1ba13c040baa4ac0fcc1446d9b73fbaa6fa808e1 100644 (file)
@@ -1,6 +1,7 @@
 """
 Invoke Function
 +++++++++++++++
+
 :class:`Operator.invoke` is used to initialize the operator from the context
 at the moment the operator is called.
 invoke() is typically used to assign properties which are then used by
index 39ff5caae8aad1e22463d96b3742e530e460e9f5..e2f9a3a84c454f0a8d7cdd2bdaf4d8149f57103a 100644 (file)
@@ -4,7 +4,7 @@ Calling a File Selector
 This example shows how an operator can use the file selector.
 
 Notice the invoke function calls a window manager method and returns
-RUNNING_MODAL, this means the file selector stays open and the operator does not
+``{'RUNNING_MODAL'}``, this means the file selector stays open and the operator does not
 exit immediately after invoke finishes.
 
 The file selector runs the operator, calling :class:`Operator.execute` when the
index 7fdccd81379479f2f7febbeb7b6a25852eb5bdca..d59c816319dc59550c27909937ded3374b78307a 100644 (file)
@@ -1,6 +1,7 @@
 """
 Dialog Box
 ++++++++++
+
 This operator uses its :class:`Operator.invoke` function to call a popup.
 """
 import bpy
index 885ed857842d2dadb1e488791955ee89673c9bc2..e5bc6e5c70da71912844397c11732b942cecbd40 100644 (file)
@@ -1,6 +1,7 @@
 """
 Custom Drawing
 ++++++++++++++
+
 By default operator properties use an automatic user interface layout.
 If you need more control you can create your own layout with a
 :class:`Operator.draw` function.
index 78030c7d7c4017d6f925645d2e70e9373e56dda5..310eeceadf3e0cf0302a60ef0b60a361f6942145 100644 (file)
@@ -1,8 +1,9 @@
 """
 Modal Execution
 +++++++++++++++
+
 This operator defines a :class:`Operator.modal` function which running,
-handling events until it returns {'FINISHED'} or {'CANCELLED'}.
+handling events until it returns ``{'FINISHED'}`` or ``{'CANCELLED'}``.
 
 Grab, Rotate, Scale and Fly-Mode are examples of modal operators.
 They are especially useful for interactive tools,
@@ -10,9 +11,9 @@ your operator can have its own state where keys toggle options as the operator
 runs.
 
 :class:`Operator.invoke` is used to initialize the operator as being by
-returning {'RUNNING_MODAL'}, initializing the modal loop.
+returning ``{'RUNNING_MODAL'}``, initializing the modal loop.
 
-Notice __init__() and __del__() are declared.
+Notice ``__init__()`` and ``__del__()`` are declared.
 For other operator types they are not useful but for modal operators they will
 be called before the :class:`Operator.invoke` and after the operator finishes.
 """
index 0981712e1ff07291d5d0d81cc0ecf25d4e64e43b..4baa9380aa6090e0679b517dbec88c37a7a99f85 100644 (file)
@@ -1,6 +1,7 @@
 """
 Basic Operator Example
 ++++++++++++++++++++++
+
 This script shows simple operator which prints a message.
 
 Since the operator only has an :class:`Operator.execute` function it takes no
index fbcdae8baebc01d235d0cc043c0b6fc8769c4d12..13a9f53fa7b3ead2289b86544ad348cf4e3b0f35 100644 (file)
@@ -1,6 +1,7 @@
 """
 Simple Object Panel
 +++++++++++++++++++
+
 This panel has a :class:`Panel.poll` and :class:`Panel.draw_header` function,
 even though the contents is basic this closely resembles blenders panels.
 """
index 1f64b953786ab25056365d84c7716b5c9590bfd0..98187832b564ced73e520d42cb88674849f0d655 100644 (file)
@@ -1,6 +1,7 @@
 """
 Basic Panel Example
 +++++++++++++++++++
+
 This script is a simple panel which will draw into the object properties
 section.
 
index feed263b2e70436b2dbe37b8d49b6b93f2e1ee9b..a02a0530a6688dfbdd7c75c4505b720a34f73cf2 100644 (file)
@@ -1,7 +1,8 @@
 """
 Advanced UIList Example - Filtering and Reordering
 ++++++++++++++++++++++++++++++++++++++++++++++++++
-This script is an extended version of the UIList subclass used to show vertex groups. It is not used 'as is',
+
+This script is an extended version of the ``UIList`` subclass used to show vertex groups. It is not used 'as is',
 because iterating over all vertices in a 'draw' function is a very bad idea for UI performances! However, it's a good
 example of how to create/use filtering/reordering callbacks.
 """