[Bf-blender-cvs] [0b4aeffda95] master: PyDoc: support building without sphinx_rtd_theme

Campbell Barton noreply at git.blender.org
Thu Oct 8 03:33:12 CEST 2020


Commit: 0b4aeffda95dd991e1fb8e5d22e552a9f165f442
Author: Campbell Barton
Date:   Thu Oct 8 12:31:26 2020 +1100
Branches: master
https://developer.blender.org/rB0b4aeffda95dd991e1fb8e5d22e552a9f165f442

PyDoc: support building without sphinx_rtd_theme

This is no longer bundled with sphinx, support building without it.

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

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 4ea63740b3c..af7461263c8 100644
--- a/doc/python_api/sphinx_doc_gen.py
+++ b/doc/python_api/sphinx_doc_gen.py
@@ -1672,15 +1672,26 @@ def write_sphinx_conf_py(basepath):
     fw("]\n\n")
 
     fw("html_title = 'Blender Python API'\n")
-    fw("html_theme = 'sphinx_rtd_theme'\n")
-    fw("html_theme_options = {\n")
-    fw("    'canonical_url': 'https://docs.blender.org/api/current/',\n")
-    # fw("    'analytics_id': '',\n")
-    # fw("    'collapse_navigation': True,\n")
-    fw("    'sticky_navigation': False,\n")
-    fw("    'navigation_depth': 1,\n")
-    # fw("    'includehidden': True,\n")
-    # fw("    'titles_only': False\n")
+
+    fw("html_theme = 'default'\n")
+    # The theme 'sphinx_rtd_theme' is no longer distributed with sphinx by default, only use when available.
+    fw(r"""
+try:
+    __import__('sphinx_rtd_theme')
+    html_theme = 'sphinx_rtd_theme'
+except ModuleNotFoundError:
+    pass
+""")
+
+    fw("if html_theme == 'sphinx_rtd_theme':\n")
+    fw("    html_theme_options = {\n")
+    fw("        'canonical_url': 'https://docs.blender.org/api/current/',\n")
+    # fw("        'analytics_id': '',\n")
+    # fw("        'collapse_navigation': True,\n")
+    fw("        'sticky_navigation': False,\n")
+    fw("        'navigation_depth': 1,\n")
+    # fw("        'includehidden': True,\n")
+    # fw("        'titles_only': False\n")
     fw("    }\n\n")
 
     # not helpful since the source is generated, adds to upload size.



More information about the Bf-blender-cvs mailing list