diff options
| author | Aaron Carlisle <carlisle.b3d@gmail.com> | 2020-10-12 00:02:41 +0300 |
|---|---|---|
| committer | Aaron Carlisle <carlisle.b3d@gmail.com> | 2020-10-12 00:02:41 +0300 |
| commit | e8a29312999baa7191c15dfeda61e7d28c78c337 (patch) | |
| tree | 33de84eadcd5eef147ec7f6043fb462b1793889b /doc | |
| parent | a38c2dcfe62bd49c360fbf30349a5b7f63ae587c (diff) | |
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
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/python_api/sphinx_doc_gen.py | 6 |
1 files changed, 3 insertions, 3 deletions
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: |