Cr8-xyz/blender
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

PYAPI: Fix mathutils doc structure

Browse Source
This commit is contained in:
Aaron Carlisle
2017-06-14 16:46:49 -04:00
parent eeb9e5316a
commit df7c609fda
2 changed files with 25 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
doc/python_api/sphinx_doc_gen.py
View File

@@ -1729,12 +1729,8 @@ def write_rst_contents(basepath):
fw(" :maxdepth: 1\n\n") fw(" :maxdepth: 1\n\n")
standalone_modules = ( standalone_modules = (
# mathutils # mathutils, submodules are in own page
"mathutils", "mathutils",
"mathutils.geometry",
"mathutils.bvhtree", "mathutils.kdtree",
"mathutils.interpolate",
"mathutils.noise",
# misc # misc
"freestyle", "bgl", "blf", "freestyle", "bgl", "blf",
"gpu", "gpu.offscreen", "gpu", "gpu.offscreen",

35
source/blender/python/mathutils/mathutils.c
View File

@@ -1,4 +1,4 @@
/* /*
* ***** BEGIN GPL LICENSE BLOCK ***** * ***** BEGIN GPL LICENSE BLOCK *****
* *
* This program is free software; you can redistribute it and/or * This program is free software; you can redistribute it and/or
@@ -38,18 +38,31 @@
#endif #endif
PyDoc_STRVAR(M_Mathutils_doc, PyDoc_STRVAR(M_Mathutils_doc,
"This module provides access to the math classes:\n" "This module provides access to math operations.\n"
"\n"
".. note::\n"
"\n"
" Classes, methods and attributes that accept vectors also accept other numeric sequences,\n"
" such as tuples, lists."
"\n\n"
"Submodules:\n"
"\n"
".. toctree::\n"
" :maxdepth: 1\n"
"\n"
" mathutils.geometry.rst\n"
" mathutils.bvhtree.rst\n"
" mathutils.kdtree.rst\n"
" mathutils.interpolate.rst\n"
" mathutils.noise.rst\n"
"\n"
"The :mod:`mathutils` module provides the following classes:\n"
"\n" "\n"
"- :class:`Color`,\n" "- :class:`Color`,\n"
"- :class:`Euler`,\n" "- :class:`Euler`,\n"
"- :class:`Matrix`,\n" "- :class:`Matrix`,\n"
"- :class:`Quaternion`,\n" "- :class:`Quaternion`,\n"
"- :class:`Vector`,\n" "- :class:`Vector`,\n"
"\n"
".. note::\n"
"\n"
" Classes, methods and attributes that accept vectors also accept other numeric sequences,\n"
" such as tuples, lists."
); );
static int mathutils_array_parse_fast(float *array, static int mathutils_array_parse_fast(float *array,
int size, int size,
@@ -219,7 +232,7 @@ int mathutils_array_parse_alloc(float **array, int array_min, PyObject *value, c
error_prefix, size, array_min); error_prefix, size, array_min);
return -1; return -1;
} }
*array = PyMem_Malloc(size * sizeof(float)); *array = PyMem_Malloc(size * sizeof(float));
memcpy(*array, ((BaseMathObject *)value)->data, size * sizeof(float)); memcpy(*array, ((BaseMathObject *)value)->data, size * sizeof(float));
return size; return size;
@@ -422,7 +435,7 @@ static Mathutils_Callback *mathutils_callbacks[MATHUTILS_TOT_CB] = {NULL};
unsigned char Mathutils_RegisterCallback(Mathutils_Callback *cb) unsigned char Mathutils_RegisterCallback(Mathutils_Callback *cb)
{ {
unsigned char i; unsigned char i;
/* find the first free slot */ /* find the first free slot */
for (i = 0; mathutils_callbacks[i]; i++) { for (i = 0; mathutils_callbacks[i]; i++) {
if (mathutils_callbacks[i] == cb) /* already registered? */ if (mathutils_callbacks[i] == cb) /* already registered? */
@@ -625,14 +638,14 @@ PyMODINIT_FUNC PyInit_mathutils(void)
return NULL; return NULL;
mod = PyModule_Create(&M_Mathutils_module_def); mod = PyModule_Create(&M_Mathutils_module_def);
/* each type has its own new() function */ /* each type has its own new() function */
PyModule_AddObject(mod, vector_Type.tp_name, (PyObject *)&vector_Type); PyModule_AddObject(mod, vector_Type.tp_name, (PyObject *)&vector_Type);
PyModule_AddObject(mod, matrix_Type.tp_name, (PyObject *)&matrix_Type); PyModule_AddObject(mod, matrix_Type.tp_name, (PyObject *)&matrix_Type);
PyModule_AddObject(mod, euler_Type.tp_name, (PyObject *)&euler_Type); PyModule_AddObject(mod, euler_Type.tp_name, (PyObject *)&euler_Type);
PyModule_AddObject(mod, quaternion_Type.tp_name, (PyObject *)&quaternion_Type); PyModule_AddObject(mod, quaternion_Type.tp_name, (PyObject *)&quaternion_Type);
PyModule_AddObject(mod, color_Type.tp_name, (PyObject *)&color_Type); PyModule_AddObject(mod, color_Type.tp_name, (PyObject *)&color_Type);
/* submodule */ /* submodule */
PyModule_AddObject(mod, "geometry", (submodule = PyInit_mathutils_geometry())); PyModule_AddObject(mod, "geometry", (submodule = PyInit_mathutils_geometry()));
/* XXX, python doesnt do imports with this usefully yet /* XXX, python doesnt do imports with this usefully yet