[Bf-blender-cvs] [e8a29312999] master: Pydoc: Cleanup: Rename function

Aaron Carlisle noreply at git.blender.org
Mon Oct 12 00:24:11 CEST 2020


Commit: e8a29312999baa7191c15dfeda61e7d28c78c337
Author: Aaron Carlisle
Date:   Sun Oct 11 17:02:41 2020 -0400
Branches: master
https://developer.blender.org/rBe8a29312999baa7191c15dfeda61e7d28c78c337

Pydoc: Cleanup: Rename function

The new name makes more sense as the file is called index and we are not 
writing the contents of all rst files

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

M	doc/python_api/sphinx_doc_gen.py

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

diff --git a/doc/python_api/sphinx_doc_gen.py b/doc/python_api/sphinx_doc_gen.py
index 53d76af4a37..35e289d9683 100644
--- a/doc/python_api/sphinx_doc_gen.py
+++ b/doc/python_api/sphinx_doc_gen.py
@@ -92,7 +92,7 @@ SCRIPT_DIR = os.path.abspath(os.path.dirname(__file__))
 # For now, ignore add-ons and internal subclasses of 'bpy.types.PropertyGroup'.
 #
 # Besides disabling this line, the main change will be to add a
-# 'toctree' to 'write_rst_contents' which contains the generated rst files.
+# 'toctree' to 'write_rst_index' which contains the generated rst files.
 # This 'toctree' can be generated automatically.
 #
 # See: D6261 for reference.
@@ -1760,7 +1760,7 @@ def execfile(filepath):
     file_handle.close()
 
 
-def write_rst_contents(basepath):
+def write_rst_index(basepath):
     '''
     Write the rst file of the main page, needed for sphinx (index.html)
     '''
@@ -2089,7 +2089,7 @@ def rna2sphinx(basepath):
     write_sphinx_conf_py(basepath)
 
     # main page
-    write_rst_contents(basepath)
+    write_rst_index(basepath)
 
     # context
     if "bpy.context" not in EXCLUDE_MODULES:



More information about the Bf-blender-cvs mailing list