diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/doxygen/Doxyfile | 2 | ||||
| -rw-r--r-- | doc/python_api/examples/gpu.7.py | 1 | ||||
| -rw-r--r-- | doc/python_api/examples/gpu.8.py | 1 | ||||
| -rw-r--r-- | doc/python_api/rst/info_overview.rst | 2 | ||||
| -rw-r--r-- | doc/python_api/sphinx_doc_gen.py | 44 |
5 files changed, 27 insertions, 23 deletions
diff --git a/doc/doxygen/Doxyfile b/doc/doxygen/Doxyfile index 1e430823b10..6e4a087fa36 100644 --- a/doc/doxygen/Doxyfile +++ b/doc/doxygen/Doxyfile @@ -38,7 +38,7 @@ PROJECT_NAME = Blender # could be handy for archiving the generated documentation or if some version # control system is used. -PROJECT_NUMBER = "V2.90" +PROJECT_NUMBER = "V2.91" # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a diff --git a/doc/python_api/examples/gpu.7.py b/doc/python_api/examples/gpu.7.py index 56cbb93c61a..d6055898807 100644 --- a/doc/python_api/examples/gpu.7.py +++ b/doc/python_api/examples/gpu.7.py @@ -20,6 +20,7 @@ from gpu_extras.presets import draw_circle_2d offscreen = gpu.types.GPUOffScreen(512, 512) with offscreen.bind(): + bgl.glClearColor(0.0, 0.0, 0.0, 0.0) bgl.glClear(bgl.GL_COLOR_BUFFER_BIT) with gpu.matrix.push_pop(): # reset matrices -> use normalized device coordinates [-1, 1] diff --git a/doc/python_api/examples/gpu.8.py b/doc/python_api/examples/gpu.8.py index 470bd8a2dad..e67c601def9 100644 --- a/doc/python_api/examples/gpu.8.py +++ b/doc/python_api/examples/gpu.8.py @@ -25,6 +25,7 @@ RING_AMOUNT = 10 offscreen = gpu.types.GPUOffScreen(WIDTH, HEIGHT) with offscreen.bind(): + bgl.glClearColor(0.0, 0.0, 0.0, 0.0) bgl.glClear(bgl.GL_COLOR_BUFFER_BIT) with gpu.matrix.push_pop(): # reset matrices -> use normalized device coordinates [-1, 1] diff --git a/doc/python_api/rst/info_overview.rst b/doc/python_api/rst/info_overview.rst index 9676489950e..50928963f60 100644 --- a/doc/python_api/rst/info_overview.rst +++ b/doc/python_api/rst/info_overview.rst @@ -248,7 +248,7 @@ using the ``bl_idname`` rather than the classes original name. .. note:: There are some exceptions to this for class names which aren't guarantee to be unique. - In this case use: :func:`bpy.types.Struct.bl_rna_get_subclass`. + In this case use: :func:`bpy.types.Struct.bl_rna_get_subclass_py`. When loading a class, Blender performs sanity checks making sure all required properties and functions are found, diff --git a/doc/python_api/sphinx_doc_gen.py b/doc/python_api/sphinx_doc_gen.py index 1b2f22217ca..2c9445dce97 100644 --- a/doc/python_api/sphinx_doc_gen.py +++ b/doc/python_api/sphinx_doc_gen.py @@ -225,6 +225,7 @@ else: "aud", "bgl", "blf", + "bl_math", "imbuf", "bmesh", "bmesh.ops", @@ -695,13 +696,11 @@ def py_descr2sphinx(ident, fw, descr, module_name, type_name, identifier): doc = undocumented_message(module_name, type_name, identifier) if type(descr) == GetSetDescriptorType: - fw(ident + ".. attribute:: %s\n" % identifier) - fw(ident + " :noindex:\n\n") + fw(ident + ".. attribute:: %s\n\n" % identifier) write_indented_lines(ident + " ", fw, doc, False) fw("\n") elif type(descr) == MemberDescriptorType: # same as above but use 'data' - fw(ident + ".. data:: %s\n" % identifier) - fw(ident + " :noindex:\n\n") + fw(ident + ".. data:: %s\n\n" % identifier) write_indented_lines(ident + " ", fw, doc, False) fw("\n") elif type(descr) in {MethodDescriptorType, ClassMethodDescriptorType}: @@ -741,14 +740,11 @@ def pyprop2sphinx(ident, fw, identifier, py_prop): ''' # readonly properties use "data" directive, variables use "attribute" directive if py_prop.fset is None: - fw(ident + ".. data:: %s\n" % identifier) - fw(ident + " :noindex:\n\n") + fw(ident + ".. data:: %s\n\n" % identifier) else: - fw(ident + ".. attribute:: %s\n" % identifier) - fw(ident + " :noindex:\n\n") + fw(ident + ".. attribute:: %s\n\n" % identifier) write_indented_lines(ident + " ", fw, py_prop.__doc__) if py_prop.fset is None: - fw("\n") fw(ident + " (readonly)\n\n") else: fw("\n") @@ -914,8 +910,7 @@ def pymodule2sphinx(basepath, module_name, module, title): elif issubclass(value_type, (bool, int, float, str, tuple)): # constant, not much fun we can do here except to list it. # TODO, figure out some way to document these! - fw(".. data:: %s\n" % attribute) - fw(" :noindex:\n\n") + fw(".. data:: %s\n\n" % attribute) write_indented_lines(" ", fw, "constant value %s" % repr(value), False) fw("\n") else: @@ -1125,8 +1120,7 @@ def pycontext2sphinx(basepath): type_descr = prop.get_type_description( class_fmt=":class:`bpy.types.%s`", collection_id=_BPY_PROP_COLLECTION_ID) - fw(".. data:: %s\n" % prop.identifier) - fw(" :noindex:\n\n") + fw(".. data:: %s\n\n" % prop.identifier) if prop.description: fw(" %s\n\n" % prop.description) @@ -1171,8 +1165,7 @@ def pycontext2sphinx(basepath): i = 0 while char_array[i] is not None: member = ctypes.string_at(char_array[i]).decode(encoding="ascii") - fw(".. data:: %s\n" % member) - fw(" :noindex:\n\n") + fw(".. data:: %s\n\n" % member) member_type, is_seq = context_type_map[member] fw(" :type: %s :class:`bpy.types.%s`\n\n" % ("sequence of " if is_seq else "", member_type)) unique.add(member) @@ -1378,11 +1371,9 @@ def pyrna2sphinx(basepath): type_descr = prop.get_type_description(class_fmt=":class:`%s`", collection_id=_BPY_PROP_COLLECTION_ID) # readonly properties use "data" directive, variables properties use "attribute" directive if 'readonly' in type_descr: - fw(" .. data:: %s\n" % prop.identifier) - fw(" :noindex:\n\n") + fw(" .. data:: %s\n\n" % prop.identifier) else: - fw(" .. attribute:: %s\n" % prop.identifier) - fw(" :noindex:\n\n") + fw(" .. attribute:: %s\n\n" % prop.identifier) if prop.description: fw(" %s\n\n" % prop.description) @@ -1798,8 +1789,18 @@ def write_rst_contents(basepath): standalone_modules = ( # submodules are added in parent page - "mathutils", "freestyle", "bgl", "blf", "imbuf", "gpu", "gpu_extras", - "aud", "bpy_extras", "idprop.types", "bmesh", + "aud", + "bgl", + "bl_math", + "blf", + "bmesh", + "bpy_extras", + "freestyle", + "gpu", + "gpu_extras", + "idprop.types", + "imbuf", + "mathutils", ) for mod in standalone_modules: @@ -1951,6 +1952,7 @@ def write_rst_importable_modules(basepath): "mathutils.kdtree": "KDTree Utilities", "mathutils.interpolate": "Interpolation Utilities", "mathutils.noise": "Noise Utilities", + "bl_math": "Additional Math Functions", "freestyle": "Freestyle Module", "freestyle.types": "Freestyle Types", "freestyle.predicates": "Freestyle Predicates", |