[Bf-blender-cvs] [318d3b9] master: Cleanup: rst style

Campbell Barton noreply at git.blender.org
Mon Feb 15 09:50:55 CET 2016


Commit: 318d3b9ab40bac7b22d10d3e00428c433670d721
Author: Campbell Barton
Date:   Mon Feb 15 19:37:37 2016 +1100
Branches: master
https://developer.blender.org/rB318d3b9ab40bac7b22d10d3e00428c433670d721

Cleanup: rst style

===================================================================

M	doc/python_api/examples/bpy.app.translations.py
M	doc/python_api/examples/bpy.ops.1.py
M	doc/python_api/examples/bpy.types.Menu.py
M	doc/python_api/rst/bge.app.rst
M	doc/python_api/rst/bgl.rst
M	doc/python_api/rst/gpu.rst

===================================================================

diff --git a/doc/python_api/examples/bpy.app.translations.py b/doc/python_api/examples/bpy.app.translations.py
index 01d5a98..6ea749c 100644
--- a/doc/python_api/examples/bpy.app.translations.py
+++ b/doc/python_api/examples/bpy.app.translations.py
@@ -3,6 +3,7 @@ Intro
 -----
 
 .. warning::
+
    Most of this object should only be useful if you actually manipulate i18n stuff from Python.
    If you are a regular addon, you should only bother about :const:`contexts` member,
    and the :func:`register`/:func:`unregister` functions! The :func:`pgettext` family of functions
@@ -12,12 +13,12 @@ Intro
 |    ``{locale: {msg_key: msg_translation, ...}, ...}``
 | where:
 
-* locale is either a lang iso code (e.g. ``fr``), a lang+country code (e.g. ``pt_BR``),
+- locale is either a lang iso code (e.g. ``fr``), a lang+country code (e.g. ``pt_BR``),
   a lang+variant code (e.g. ``sr at latin``), or a full code (e.g. ``uz_UZ at cyrilic``).
-* msg_key is a tuple (context, org message) - use, as much as possible, the predefined :const:`contexts`.
-* msg_translation is the translated message in given language!
+- msg_key is a tuple (context, org message) - use, as much as possible, the predefined :const:`contexts`.
+- msg_translation is the translated message in given language!
 
-Then, call ``bpy.app.translations.register(__name__, your_dict)`` in your ``register()`` function, and \n"
+Then, call ``bpy.app.translations.register(__name__, your_dict)`` in your ``register()`` function, and
 ``bpy.app.translations.unregister(__name__)`` in your ``unregister()`` one.
 
 The ``Manage UI translations`` addon has several functions to help you collect strings to translate, and
diff --git a/doc/python_api/examples/bpy.ops.1.py b/doc/python_api/examples/bpy.ops.1.py
index d89a136..7fdde45 100644
--- a/doc/python_api/examples/bpy.ops.1.py
+++ b/doc/python_api/examples/bpy.ops.1.py
@@ -12,6 +12,7 @@ For example to override ``bpy.context.active_object``,
 you would pass ``{'active_object': object}``.
 
 .. note::
+
    You will nearly always want to use a copy of the actual current context as basis
    (otherwise, you'll have to find and gather all needed data yourself).
 """
diff --git a/doc/python_api/examples/bpy.types.Menu.py b/doc/python_api/examples/bpy.types.Menu.py
index c216244..295c108 100644
--- a/doc/python_api/examples/bpy.types.Menu.py
+++ b/doc/python_api/examples/bpy.types.Menu.py
@@ -9,9 +9,11 @@ Notice the 'CATEGORY_MT_name' in  :class:`Menu.bl_idname`, this is a naming
 convention for menus.
 
 .. note::
+
    Menu subclasses must be registered before referencing them from blender.
 
 .. note::
+
    Menus have their :class:`Layout.operator_context` initialized as
    'EXEC_REGION_WIN' rather than 'INVOKE_DEFAULT' (see :ref:`Execution Context <operator-execution_context>`).
    If the operator context needs to initialize inputs from the
diff --git a/doc/python_api/rst/bge.app.rst b/doc/python_api/rst/bge.app.rst
index a0c2cf3..34b9263 100644
--- a/doc/python_api/rst/bge.app.rst
+++ b/doc/python_api/rst/bge.app.rst
@@ -10,38 +10,41 @@ Module to access application values that remain unchanged during runtime.
 
    The Blender/BGE version as a tuple of 3 ints, eg. (2, 75, 1).
 
-   .. note:: Version tuples can be compared simply with (in)equality symbols;
-             for example, ``(2, 74, 5) <= (2, 75, 0)`` returns True (lexical order).
-             
+   .. note::
+
+      Version tuples can be compared simply with (in)equality symbols;
+      for example, ``(2, 74, 5) <= (2, 75, 0)`` returns True (lexical order).
+
    :type: tuple of three ints
 
 .. data:: version_string
 
    The Blender/BGE version formatted as a string, eg. "2.75 (sub 1)".
-   
+
    :type: str
 
 .. data:: version_char
 
    The Blender/BGE version character (for minor releases).
-   
+
    :type: str
 
 .. data:: has_texture_ffmpeg
 
-   True if the BGE has been built with FFmpeg support, enabling use of :class:`~bge.texture.ImageFFmpeg` and :class:`~bge.texture.VideoFFmpeg`.
-   
+   True if the BGE has been built with FFmpeg support,
+   enabling use of :class:`~bge.texture.ImageFFmpeg` and :class:`~bge.texture.VideoFFmpeg`.
+
    :type: bool
 
 .. data:: has_joystick
 
    True if the BGE has been built with joystick support.
-   
+
    :type: bool
 
 .. data:: has_physics
 
    True if the BGE has been built with physics support.
-   
+
    :type: bool
 
diff --git a/doc/python_api/rst/bgl.rst b/doc/python_api/rst/bgl.rst
index 8b0ad63..36e07a1 100644
--- a/doc/python_api/rst/bgl.rst
+++ b/doc/python_api/rst/bgl.rst
@@ -20,6 +20,7 @@ offers a set of extensive examples, including advanced features.
 
 
 .. note::
+
    You can use the :class:`Image` type to load and set textures.
    See :class:`Image.gl_load` and :class:`Image.gl_load`,
    for example.
diff --git a/doc/python_api/rst/gpu.rst b/doc/python_api/rst/gpu.rst
index 5e7486f..6c38122 100644
--- a/doc/python_api/rst/gpu.rst
+++ b/doc/python_api/rst/gpu.rst
@@ -186,6 +186,7 @@ GLSL Lamp Uniforms
       mat4_world_to_cam_ * (-vec3_lamp_Z_axis)
 
    .. note::
+
       - The lamp Z axis points to the opposite direction of light.
       - The norm of the vector should be unit length.




More information about the Bf-blender-cvs mailing list