[Bf-blender-cvs] SVN commit: /data/svn/bf-blender [44395] trunk/blender: bmesh docs now written in sphinx doc generator.

Campbell Barton ideasman42 at gmail.com
Fri Feb 24 10:53:30 CET 2012


Revision: 44395
          http://projects.blender.org/scm/viewvc.php?view=rev&root=bf-blender&revision=44395
Author:   campbellbarton
Date:     2012-02-24 09:53:29 +0000 (Fri, 24 Feb 2012)
Log Message:
-----------
bmesh docs now written in sphinx doc generator.
* http://www.blender.org/documentation/blender_python_api_2_62_0/bmesh.types.html
* http://www.blender.org/documentation/blender_python_api_2_62_0/bmesh.utils.html

Modified Paths:
--------------
    trunk/blender/doc/python_api/sphinx_doc_gen.py
    trunk/blender/extern/recastnavigation/Detour/Source/DetourStatNavMesh.cpp
    trunk/blender/extern/recastnavigation/Recast/Source/RecastLayers.cpp
    trunk/blender/source/blender/makesrna/intern/rna_nodetree.c
    trunk/blender/source/blender/python/bmesh/bmesh_py_types.c

Modified: trunk/blender/doc/python_api/sphinx_doc_gen.py
===================================================================
--- trunk/blender/doc/python_api/sphinx_doc_gen.py	2012-02-24 09:49:44 UTC (rev 44394)
+++ trunk/blender/doc/python_api/sphinx_doc_gen.py	2012-02-24 09:53:29 UTC (rev 44395)
@@ -66,12 +66,12 @@
     FILTER_BPY_OPS = None
 
 else:
-    EXCLUDE_INFO_DOCS = False
+    EXCLUDE_INFO_DOCS = True
     # for testing so doc-builds dont take so long.
     EXCLUDE_MODULES = (
         "bpy.context",
-        #"bpy.app",
-        #"bpy.app.handlers",
+        "bpy.app",
+        "bpy.app.handlers",
         "bpy.path",
         "bpy.data",
         "bpy.props",
@@ -88,6 +88,9 @@
         "mathutils",
         "mathutils.geometry",
         "mathutils.noise",
+        #"bmesh",
+        #"bmesh.types",
+        #"bmesh.utils",
     )
 
     FILTER_BPY_TYPES = ("bpy_struct", "Operator", "ID")  # allow
@@ -1189,12 +1192,14 @@
     fw(".. toctree::\n")
     fw("   :maxdepth: 1\n\n")
 
+    # mathutils
     if "mathutils" not in EXCLUDE_MODULES:
         fw("   mathutils.rst\n\n")
     if "mathutils.geometry" not in EXCLUDE_MODULES:
         fw("   mathutils.geometry.rst\n\n")
     if "mathutils.noise" not in EXCLUDE_MODULES:
         fw("   mathutils.noise.rst\n\n")
+    # misc
     if "bgl" not in EXCLUDE_MODULES:
         fw("   bgl.rst\n\n")
     if "blf" not in EXCLUDE_MODULES:
@@ -1205,6 +1210,13 @@
         fw("   aud.rst\n\n")
     if "bpy_extras" not in EXCLUDE_MODULES:
         fw("   bpy_extras.rst\n\n")
+    # bmesh
+    if "bmesh" not in EXCLUDE_MODULES:
+        fw("   bmesh.rst\n\n")
+    if "bmesh.types" not in EXCLUDE_MODULES:
+        fw("   bmesh.types.rst\n\n")
+    if "bmesh.utils" not in EXCLUDE_MODULES:
+        fw("   bmesh.utils.rst\n\n")
 
     # game engine
     if "bge" not in EXCLUDE_MODULES:
@@ -1338,6 +1350,18 @@
         import mathutils.noise as module
         pymodule2sphinx(BASEPATH, "mathutils.noise", module, "Noise Utilities")
 
+    if "bmesh" not in EXCLUDE_MODULES:
+        import bmesh as module
+        pymodule2sphinx(BASEPATH, "bmesh", module, "BMesh Module")
+
+    if "bmesh.types" not in EXCLUDE_MODULES:
+        import bmesh.types as module
+        pymodule2sphinx(BASEPATH, "bmesh.types", module, "BMesh Types")
+
+    if "bmesh.utils" not in EXCLUDE_MODULES:
+        import bmesh.utils as module
+        pymodule2sphinx(BASEPATH, "bmesh.utils", module, "BMesh Utilities")
+
     if "blf" not in EXCLUDE_MODULES:
         import blf as module
         pymodule2sphinx(BASEPATH, "blf", module, "Font Drawing")

Modified: trunk/blender/extern/recastnavigation/Detour/Source/DetourStatNavMesh.cpp
===================================================================
--- trunk/blender/extern/recastnavigation/Detour/Source/DetourStatNavMesh.cpp	2012-02-24 09:49:44 UTC (rev 44394)
+++ trunk/blender/extern/recastnavigation/Detour/Source/DetourStatNavMesh.cpp	2012-02-24 09:53:29 UTC (rev 44395)
@@ -566,7 +566,7 @@
 			hitPos[2] = vj[2] + (vi[2] - vj[2])*tseg;
 		}
 
-		// Check to see if teh circle expands to one of the neighbours and expand.
+		// Check to see if the circle expands to one of the neighbours and expand.
 		for (int i = 0, j = (int)poly->nv-1; i < (int)poly->nv; j = i++)
 		{
 			// Skip solid edges.

Modified: trunk/blender/extern/recastnavigation/Recast/Source/RecastLayers.cpp
===================================================================
--- trunk/blender/extern/recastnavigation/Recast/Source/RecastLayers.cpp	2012-02-24 09:49:44 UTC (rev 44394)
+++ trunk/blender/extern/recastnavigation/Recast/Source/RecastLayers.cpp	2012-02-24 09:53:29 UTC (rev 44395)
@@ -368,7 +368,7 @@
 				rcLayerRegion& rj = regs[j];
 				if (!rj.base) continue;
 				
-				// Skip if teh regions are not close to each other.
+				// Skip if the regions are not close to each other.
 				if (!overlapRange(ri.ymin,ri.ymax+mergeHeight, rj.ymin,rj.ymax+mergeHeight))
 					continue;
 				// Skip if the height range would become too large.

Modified: trunk/blender/source/blender/makesrna/intern/rna_nodetree.c
===================================================================
--- trunk/blender/source/blender/makesrna/intern/rna_nodetree.c	2012-02-24 09:49:44 UTC (rev 44394)
+++ trunk/blender/source/blender/makesrna/intern/rna_nodetree.c	2012-02-24 09:53:29 UTC (rev 44395)
@@ -628,7 +628,7 @@
 
 static bNode *rna_NodeTree_node_composite_new(bNodeTree *ntree, bContext *C, ReportList *reports, int type, bNodeTree *group)
 {
-	/* raises error on failier */
+	/* raises error on failure */
 	bNode *node= rna_NodeTree_node_new(ntree, C, reports, type, group);
 	
 	if (node) {
@@ -653,7 +653,7 @@
 
 static bNode *rna_NodeTree_node_texture_new(bNodeTree *ntree, bContext *C, ReportList *reports, int type, bNodeTree *group)
 {
-	/* raises error on failier */
+	/* raises error on failure */
 	bNode *node= rna_NodeTree_node_new(ntree, C, reports, type, group);
 
 	if (node) {

Modified: trunk/blender/source/blender/python/bmesh/bmesh_py_types.c
===================================================================
--- trunk/blender/source/blender/python/bmesh/bmesh_py_types.c	2012-02-24 09:49:44 UTC (rev 44394)
+++ trunk/blender/source/blender/python/bmesh/bmesh_py_types.c	2012-02-24 09:53:29 UTC (rev 44395)
@@ -126,6 +126,7 @@
 	}
 }
 
+
 PyDoc_STRVAR(bpy_bm_elem_index_doc,
 "Index of this element.\n"
 "\n"
@@ -137,7 +138,7 @@
 "\n"
 "   It's also possible to assign any number to this attribute for a scripts internal logic.\n"
 "\n"
-"   To ensure the value is up to date - see :class:`BMesh.update` **index** argument.\n"
+"   To ensure the value is up to date - see :class:`BMElemSeq.index_update`.\n"
 );
 static PyObject *bpy_bm_elem_index_get(BPy_BMElem *self, void *UNUSED(flag))
 {
@@ -194,6 +195,7 @@
 	return BPy_BMElemSeq_CreatePyObject(self->bm, NULL, GET_INT_FROM_POINTER(itype));
 }
 
+
 /* vert */
 PyDoc_STRVAR(bpy_bmvert_link_edges_doc,
 "Edges connected to this vertex (read-only).\n\n:type: :class:`BMElemSeq` of :class:`BMVert`"
@@ -235,6 +237,7 @@
 	return BPy_BMElemSeq_CreatePyObject(self->bm, self, GET_INT_FROM_POINTER(itype));
 }
 
+
 PyDoc_STRVAR(bpy_bm_is_valid_doc,
 "True when this element is valid (hasn't been removed).\n\n:type: boolean"
 );
@@ -297,6 +300,7 @@
 	}
 }
 
+
 PyDoc_STRVAR(bpy_bmvert_normal_doc,
 "The normal for this vertex as a 3D, wrapped vector.\n\n:type: :class:`mathutils.Vector`"
 );
@@ -318,6 +322,7 @@
 	}
 }
 
+
 PyDoc_STRVAR(bpy_bmvert_is_manifold_doc,
 "True when this vertex is manifold (read-only).\n\n:type: boolean"
 );
@@ -327,6 +332,7 @@
 	return PyBool_FromLong(BM_vert_is_manifold(self->bm, self->v));
 }
 
+
 PyDoc_STRVAR(bpy_bmvert_is_wire_doc,
 "True when this vertex is not connected to any faces (read-only).\n\n:type: boolean"
 );
@@ -336,6 +342,7 @@
 	return PyBool_FromLong(BM_vert_is_wire(self->bm, self->v));
 }
 
+
 /* Edge
  * ^^^^ */
 
@@ -348,6 +355,7 @@
 	return PyBool_FromLong(BM_edge_is_manifold(self->bm, self->e));
 }
 
+
 PyDoc_STRVAR(bpy_bmedge_is_wire_doc,
 "True when this edge is not connected to any faces (read-only).\n\n:type: boolean"
 );
@@ -357,6 +365,7 @@
 	return PyBool_FromLong(BM_edge_is_wire(self->bm, self->e));
 }
 
+
 PyDoc_STRVAR(bpy_bmedge_is_boundary_doc,
 "True when this edge is at the boundary of a face (read-only).\n\n:type: boolean"
 );
@@ -366,6 +375,7 @@
 	return PyBool_FromLong(BM_edge_is_boundary(self->e));
 }
 
+
 /* Face
  * ^^^^ */
 
@@ -493,6 +503,7 @@
 /* Methods
  * ======= */
 
+
 /* Mesh
  * ---- */
 
@@ -510,6 +521,7 @@
 	Py_RETURN_NONE;
 }
 
+
 PyDoc_STRVAR(bpy_bmesh_select_flush_doc,
 ".. method:: select_flush(select)\n"
 "\n"
@@ -536,6 +548,7 @@
 	Py_RETURN_NONE;
 }
 
+
 PyDoc_STRVAR(bpy_bmesh_normal_update_doc,
 ".. method:: normal_update(skip_hidden=False)\n"
 "\n"
@@ -628,6 +641,7 @@
 	Py_RETURN_NONE;
 }
 
+
 /* Elem
  * ---- */
 
@@ -657,6 +671,7 @@
 	Py_RETURN_NONE;
 }
 
+
 PyDoc_STRVAR(bpy_bm_elem_copy_from_doc,
 ".. method:: copy_from(select)\n"
 "\n"
@@ -693,6 +708,7 @@
 	return PyFloat_FromDouble(BM_vert_edge_angle(self->bm, self->v));
 }
 
+
 /* Edge
  * ---- */
 
@@ -710,6 +726,7 @@
 	return PyFloat_FromDouble(BM_edge_face_angle(self->bm, self->e));
 }
 
+
 PyDoc_STRVAR(bpy_bmedge_other_vert_doc,
 ".. method:: other_vert(vert)\n"
 "\n"
@@ -751,6 +768,7 @@
 	}
 }
 
+
 /* Face
  * ---- */
 
@@ -797,6 +815,7 @@
 	}
 }
 
+
 PyDoc_STRVAR(bpy_bmface_calc_area_doc,
 ".. method:: calc_area()\n"
 "\n"
@@ -811,6 +830,7 @@
 	return PyFloat_FromDouble(BM_face_area_calc(self->bm, self->f));
 }
 
+
 PyDoc_STRVAR(bpy_bmface_calc_center_mean_doc,
 ".. method:: calc_center_median()\n"
 "\n"
@@ -828,6 +848,7 @@
 	return Vector_CreatePyObject(cent, 3, Py_NEW, NULL);
 }
 
+
 PyDoc_STRVAR(bpy_bmface_calc_center_bounds_doc,
 ".. method:: calc_center_bounds()\n"
 "\n"
@@ -845,6 +866,7 @@
 	return Vector_CreatePyObject(cent, 3, Py_NEW, NULL);
 }
 
+
 /* Loop
  * ---- */
 
@@ -863,6 +885,7 @@
 	return PyFloat_FromDouble(BM_loop_face_angle(self->bm, self->l));
 }
 
+
 /* Vert Seq
  * -------- */
 
@@ -1193,6 +1216,7 @@
 	}
 }
 
+
 PyDoc_STRVAR(bpy_bmelemseq_index_update_doc,
 ".. method:: index_update()\n"
 "\n"




More information about the Bf-blender-cvs mailing list