Browse Source

Merge pull request #8789 from mhilbrunner/fix-rtd

[3.2] Fix ReadTheDocs build and remove sphinx_search.extension
Max Hilbrunner 1 năm trước cách đây
mục cha
commit
384ffa3e8f
3 tập tin đã thay đổi với 11 bổ sung4 xóa
  1. 3 1
      .readthedocs.yml
  2. 0 3
      conf.py
  3. 8 0
      requirements.txt

+ 3 - 1
.readthedocs.yml

@@ -5,7 +5,9 @@
 version: 2
 version: 2
 
 
 build:
 build:
-  image: latest
+  os: ubuntu-22.04
+  tools:
+    python: "3.9"
 
 
 sphinx:
 sphinx:
   configuration: conf.py
   configuration: conf.py

+ 0 - 3
conf.py

@@ -61,9 +61,6 @@ ogp_site_name = "Godot Engine documentation"
 if not os.getenv("SPHINX_NO_GDSCRIPT"):
 if not os.getenv("SPHINX_NO_GDSCRIPT"):
     extensions.append("gdscript")
     extensions.append("gdscript")
 
 
-if not os.getenv("SPHINX_NO_SEARCH"):
-    extensions.append("sphinx_search.extension")
-
 if not os.getenv("SPHINX_NO_DESCRIPTIONS"):
 if not os.getenv("SPHINX_NO_DESCRIPTIONS"):
     extensions.append("godot_descriptions")
     extensions.append("godot_descriptions")
 
 

+ 8 - 0
requirements.txt

@@ -6,6 +6,7 @@
 sphinx==3.5.2
 sphinx==3.5.2
 sphinx_rtd_theme==0.5.2
 sphinx_rtd_theme==0.5.2
 docutils<0.18
 docutils<0.18
+Jinja2<3.1
 
 
 # Code tabs extension for GDScript/C#
 # Code tabs extension for GDScript/C#
 # Stay on 1.3.0 until https://github.com/readthedocs/readthedocs-sphinx-search/issues/82 is fixed.
 # Stay on 1.3.0 until https://github.com/readthedocs/readthedocs-sphinx-search/issues/82 is fixed.
@@ -19,3 +20,10 @@ sphinxext-opengraph==0.4.2
 
 
 # Full-page search UI for RTD: https://readthedocs-sphinx-search.readthedocs.io
 # Full-page search UI for RTD: https://readthedocs-sphinx-search.readthedocs.io
 readthedocs-sphinx-search==0.1.0
 readthedocs-sphinx-search==0.1.0
+
+# These get pulled in by Sphinx, we need to pin these as higher versions require Sphinx 5.0+.
+sphinxcontrib-applehelp<=1.0.4
+sphinxcontrib-htmlhelp<=2.0.1
+sphinxcontrib-qthelp<=1.0.3
+sphinxcontrib-serializinghtml<=1.1.5
+sphinxcontrib-devhelp<=1.0.2