[Bf-blender-cvs] [a96030b3da4] master: PyAPI: Add toctree link on parent page of submodule

Aaron Carlisle noreply at git.blender.org
Thu Jun 15 07:42:50 CEST 2017


Commit: a96030b3da44dc66be861bd05380f5be24a9c1a1
Author: Aaron Carlisle
Date:   Thu Jun 15 01:41:28 2017 -0400
Branches: master
https://developer.blender.org/rBa96030b3da44dc66be861bd05380f5be24a9c1a1

PyAPI: Add toctree link on parent page of submodule

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

M	doc/python_api/rst/gpu.rst
M	doc/python_api/rst_from_bmesh_opdefines.py
M	doc/python_api/sphinx_doc_gen.py

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

diff --git a/doc/python_api/rst/gpu.rst b/doc/python_api/rst/gpu.rst
index 6c38122a573..cf639357a31 100644
--- a/doc/python_api/rst/gpu.rst
+++ b/doc/python_api/rst/gpu.rst
@@ -6,6 +6,13 @@ GPU functions (gpu)
 
 This module provides access to materials GLSL shaders.
 
+Submodules:
+
+.. toctree::
+   :maxdepth: 1
+
+   gpu.offscreen.rst
+
 
 Intro
 =====
@@ -24,7 +31,6 @@ and in the game engine.
 Constants
 =========
 
-
 GLSL Data Type
 --------------
 
diff --git a/doc/python_api/rst_from_bmesh_opdefines.py b/doc/python_api/rst_from_bmesh_opdefines.py
index cdbed88cc88..d3e4b2a0cfd 100644
--- a/doc/python_api/rst_from_bmesh_opdefines.py
+++ b/doc/python_api/rst_from_bmesh_opdefines.py
@@ -22,7 +22,7 @@
 # 'bmesh_opdefines.c' in order to avoid having to add a lot of introspection
 # data access into the api.
 #
-# The script is stupid becase it makes assumptions about formatting...
+# The script is stupid because it makes assumptions about formatting...
 # that each arg has its own line, that comments above or directly after will be __doc__ etc...
 #
 # We may want to replace this script with something else one day but for now its good enough.
diff --git a/doc/python_api/sphinx_doc_gen.py b/doc/python_api/sphinx_doc_gen.py
index d2c6ade1e25..241929c24d9 100644
--- a/doc/python_api/sphinx_doc_gen.py
+++ b/doc/python_api/sphinx_doc_gen.py
@@ -1729,15 +1729,9 @@ def write_rst_contents(basepath):
     fw("   :maxdepth: 1\n\n")
 
     standalone_modules = (
-        # mathutils, submodules are in own page
-        "mathutils",
-        # misc
-        "freestyle", "bgl", "blf",
-        "gpu", "gpu.offscreen",
-        "aud", "bpy_extras",
-        "idprop.types",
-        # bmesh, submodules are in own page
-        "bmesh",
+        # submodules are added in parent page
+        "mathutils", "freestyle", "bgl", "blf", "gpu",
+        "aud", "bpy_extras", "idprop.types", "bmesh",
     )
 
     for mod in standalone_modules:




More information about the Bf-blender-cvs mailing list