kannonier8/blender
1
0
Fork 0
forked from bartvdbraak/blender
Code Pull Requests Activity

Python API Docs: better titles.

Browse Source 
The HTML title did not make it clear that these are docs for the API rather
than a general Blender documentation. Some of the page titles were also too
long and redundant.
This commit is contained in:
Brecht Van Lommel 2018-11-21 17:21:28 +01:00
parent f5df1efa2f
commit d203234dd0
1 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
doc/python_api/sphinx_doc_gen.py
View File

@ -340,11 +340,11 @@ RST_DIR = os.path.abspath(os.path.join(SCRIPT_DIR, "rst"))
# stored in ./rst/info_* # stored in ./rst/info_*
INFO_DOCS = ( INFO_DOCS = (
("info_quickstart.rst", ("info_quickstart.rst",
"Blender/Python Quickstart: new to Blender/scripting and want to get your feet wet?"), "Quickstart: new to Blender or scripting and want to get your feet wet?"),
("info_overview.rst", ("info_overview.rst",
"Blender/Python API Overview: a more complete explanation of Python integration"), "API Overview: a more complete explanation of Python integration"),
("info_api_reference.rst", ("info_api_reference.rst",
"Blender/Python API Reference Usage: examples of how to use the API reference docs"), "API Reference Usage: examples of how to use the API reference docs"),
("info_best_practice.rst", ("info_best_practice.rst",
"Best Practice: Conventions to follow for writing good scripts"), "Best Practice: Conventions to follow for writing good scripts"),
("info_tips_and_tricks.rst", ("info_tips_and_tricks.rst",
@ -1620,6 +1620,7 @@ def write_sphinx_conf_py(basepath):
fw(" 'include__bmesh.rst',\n") fw(" 'include__bmesh.rst',\n")
fw("]\n\n") fw("]\n\n")
fw("html_title = 'Blender %s Python API'\n" % BLENDER_VERSION_DOTS)
fw("html_theme = 'sphinx_rtd_theme'\n") fw("html_theme = 'sphinx_rtd_theme'\n")
# not helpful since the source is generated, adds to upload size. # not helpful since the source is generated, adds to upload size.
fw("html_copy_source = False\n") fw("html_copy_source = False\n")
@ -1671,21 +1672,21 @@ def write_rst_contents(basepath):
file = open(filepath, "w", encoding="utf-8") file = open(filepath, "w", encoding="utf-8")
fw = file.write fw = file.write
fw(title_string("Blender Documentation Contents", "%", double=True)) fw(title_string("Blender Python API Documentation", "%", double=True))
fw("\n") fw("\n")
fw("Welcome, this document is an API reference for Blender %s, built %s.\n" % fw("Welcome to the API reference for Blender %s, built %s.\n" %
(BLENDER_VERSION_DOTS, BLENDER_DATE)) (BLENDER_VERSION_DOTS, BLENDER_DATE))
fw("\n") fw("\n")
# fw("`A PDF version of this document is also available <%s>`_\n" % BLENDER_PDF_FILENAME) # fw("`A PDF version of this document is also available <%s>`_\n" % BLENDER_PDF_FILENAME)
fw("This site can be downloaded for offline use `Download the full Documentation (zipped HTML files) <%s>`_\n" % fw("This site can be downloaded for offline use: `Download the full Documentation (zipped HTML files) <%s>`_\n" %
BLENDER_ZIP_FILENAME) BLENDER_ZIP_FILENAME)
fw("\n") fw("\n")
if not EXCLUDE_INFO_DOCS: if not EXCLUDE_INFO_DOCS:
fw(".. toctree::\n") fw(".. toctree::\n")
fw(" :maxdepth: 1\n") fw(" :maxdepth: 1\n")
fw(" :caption: Blender/Python Documentation\n\n") fw(" :caption: Documentation\n\n")
for info, info_desc in INFO_DOCS: for info, info_desc in INFO_DOCS:
fw(" %s <%s>\n" % (info_desc, info)) fw(" %s <%s>\n" % (info_desc, info))
fw("\n") fw("\n")