From 4341ec236edfb2f670a08810d6a85a27c06d73c0 Mon Sep 17 00:00:00 2001 From: Dylan Northrup Date: Mon, 9 Oct 2023 13:30:14 -0400 Subject: [PATCH 01/11] Append closing "/" to meta description tag; do not add new description tag if one already exists --- _extensions/godot_descriptions.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/_extensions/godot_descriptions.py b/_extensions/godot_descriptions.py index 3f6f8c49210..2e8cf4c4052 100644 --- a/_extensions/godot_descriptions.py +++ b/_extensions/godot_descriptions.py @@ -103,10 +103,11 @@ def generate_description(app, pagename, templatename, context, doctree): doctree.walkabout(generator) description = ( - '\n' + '\n' ) - context["metatags"] += description + if not re.search(' Date: Mon, 9 Oct 2023 13:31:01 -0400 Subject: [PATCH 02/11] Add closing "/" to all meta tags --- _templates/layout.html | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/_templates/layout.html b/_templates/layout.html index 268c4ca381a..286d9f866a9 100644 --- a/_templates/layout.html +++ b/_templates/layout.html @@ -6,12 +6,12 @@ {% endblock -%} {% block extrahead -%} - - + + {% endblock -%} {% block linktags -%} - + {% if godot_inject_language_links -%} {% for alternate_lang in godot_docs_supported_languages -%} {# Convert to ISO 639-1 format, e.g. zh_CN -> zh-cn -#} @@ -66,7 +66,6 @@ {% endif %} {% block body %}{% endblock %} - {%- if self.comments()|trim %}
{%- block comments %}{% endblock %} From 21da61263b85cff6a90cdee3882448bb2d0febd6 Mon Sep 17 00:00:00 2001 From: Dylan Northrup Date: Mon, 9 Oct 2023 13:32:34 -0400 Subject: [PATCH 03/11] Remove URL parameters from css/js paths to fix ThemeError --- conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/conf.py b/conf.py index 49c7638da9d..6c23613462b 100644 --- a/conf.py +++ b/conf.py @@ -199,14 +199,14 @@ html_css_files = [ 'css/algolia.css', 'https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css', - "css/custom.css?10", # Increment the number at the end when the file changes to bust the cache. + "css/custom.css", ] if not on_rtd: html_css_files.append("css/dev.css") html_js_files = [ - "js/custom.js?6", # Increment the number at the end when the file changes to bust the cache. + "js/custom.js", ('https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js', {'defer': 'defer'}), ('js/algolia.js', {'defer': 'defer'}) ] From 3352defbe885d38917714cfcf8eb6cf6f2fb0ee2 Mon Sep 17 00:00:00 2001 From: Dylan Northrup Date: Mon, 9 Oct 2023 13:32:58 -0400 Subject: [PATCH 04/11] Updating package versions to reflect the latest versions in the readthedocs github repo --- requirements.txt | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/requirements.txt b/requirements.txt index b25d1e97310..7ceeb47bcb5 100644 --- a/requirements.txt +++ b/requirements.txt @@ -3,19 +3,19 @@ # https://github.com/readthedocs/readthedocs.org/blob/master/requirements/docs.txt # Base dependencies -pygments==2.15.1 +pygments==2.16.1 # Sphinx base and RTD theme. -sphinx==4.4.0 -sphinx_rtd_theme==1.1.1 +sphinx==7.2.6 +sphinx_rtd_theme==2.0.0rc2 # Sphinx extensions. # Code tabs extension to display codeblocks in different languages as tabs. -sphinx-tabs==3.4.0 +sphinx-tabs==3.4.1 # Adds a 'copy' button to the right of codeblocks. -sphinx-copybutton==0.5.1 +sphinx-copybutton==0.5.2 # Custom 404 error page (more useful than the default). -sphinx-notfound-page==0.8.3 +sphinx-notfound-page==1.0.0 # Adds Open Graph tags in the HTML `` tag. -sphinxext-opengraph==0.7.5 +sphinxext-opengraph==0.8.2 From 704afa2137ecf80cf2754c3c2c490dd8de7df7e6 Mon Sep 17 00:00:00 2001 From: Dylan Northrup Date: Tue, 10 Oct 2023 10:33:42 -0400 Subject: [PATCH 05/11] noop change to trigger CI workflow --- requirements.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/requirements.txt b/requirements.txt index 7ceeb47bcb5..4b15eb496a3 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,6 +1,7 @@ # Sync with readthedocs: # https://github.com/readthedocs/readthedocs.org/blob/master/requirements/pip.txt # https://github.com/readthedocs/readthedocs.org/blob/master/requirements/docs.txt +# Noop # Base dependencies pygments==2.16.1 From 57a30ca586af7b7fbe6d79f80c7044a4349bfd9d Mon Sep 17 00:00:00 2001 From: Dylan Northrup Date: Tue, 10 Oct 2023 10:38:31 -0400 Subject: [PATCH 06/11] Add verbose option to "pip3 install" --- .github/workflows/ci.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index dac9fa87d2c..68f0c6a70c8 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -20,7 +20,7 @@ jobs: # Install tools used by `_tools/format.sh`. sudo apt-get -qq update sudo apt-get -qq install dos2unix recode - sudo pip3 install -r requirements.txt + sudo pip3 -v install -r requirements.txt sudo pip3 install codespell - name: Linter checks From 1dff25c019ca73ea8c6b8f4cc36d96bf2c2c0cd6 Mon Sep 17 00:00:00 2001 From: Dylan Northrup Date: Tue, 10 Oct 2023 10:59:31 -0400 Subject: [PATCH 07/11] Update python version to 3.9 --- .github/workflows/ci.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 68f0c6a70c8..6c4a976bf34 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -19,7 +19,7 @@ jobs: run: | # Install tools used by `_tools/format.sh`. sudo apt-get -qq update - sudo apt-get -qq install dos2unix recode + sudo apt-get -qq install python3.9 dos2unix recode sudo pip3 -v install -r requirements.txt sudo pip3 install codespell From b4cb5a04839fcf42025a172137f9ddeba6e16c14 Mon Sep 17 00:00:00 2001 From: Dylan Northrup Date: Tue, 10 Oct 2023 11:03:18 -0400 Subject: [PATCH 08/11] Debug Iteration --- .github/workflows/ci.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 6c4a976bf34..ba505b2ba86 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -20,6 +20,8 @@ jobs: # Install tools used by `_tools/format.sh`. sudo apt-get -qq update sudo apt-get -qq install python3.9 dos2unix recode + python3 --version + python3.9 --version sudo pip3 -v install -r requirements.txt sudo pip3 install codespell From 5429403e47ba74e7216753cfbd12c8c6aea0b2ef Mon Sep 17 00:00:00 2001 From: Dylan Northrup Date: Sun, 22 Oct 2023 18:47:01 -0400 Subject: [PATCH 09/11] Revert CI testing changes --- .github/workflows/ci.yml | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index ba505b2ba86..dac9fa87d2c 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -19,10 +19,8 @@ jobs: run: | # Install tools used by `_tools/format.sh`. sudo apt-get -qq update - sudo apt-get -qq install python3.9 dos2unix recode - python3 --version - python3.9 --version - sudo pip3 -v install -r requirements.txt + sudo apt-get -qq install dos2unix recode + sudo pip3 install -r requirements.txt sudo pip3 install codespell - name: Linter checks From 2647e6b5c150dfc11ff6ce8d3e5422c8ef880c9d Mon Sep 17 00:00:00 2001 From: Dylan Northrup Date: Sun, 22 Oct 2023 18:47:40 -0400 Subject: [PATCH 10/11] Revert module upgrades and changes it required --- conf.py | 4 ++-- requirements.txt | 15 +++++++-------- 2 files changed, 9 insertions(+), 10 deletions(-) diff --git a/conf.py b/conf.py index 6c23613462b..49c7638da9d 100644 --- a/conf.py +++ b/conf.py @@ -199,14 +199,14 @@ html_css_files = [ 'css/algolia.css', 'https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css', - "css/custom.css", + "css/custom.css?10", # Increment the number at the end when the file changes to bust the cache. ] if not on_rtd: html_css_files.append("css/dev.css") html_js_files = [ - "js/custom.js", + "js/custom.js?6", # Increment the number at the end when the file changes to bust the cache. ('https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js', {'defer': 'defer'}), ('js/algolia.js', {'defer': 'defer'}) ] diff --git a/requirements.txt b/requirements.txt index 4b15eb496a3..b25d1e97310 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,22 +1,21 @@ # Sync with readthedocs: # https://github.com/readthedocs/readthedocs.org/blob/master/requirements/pip.txt # https://github.com/readthedocs/readthedocs.org/blob/master/requirements/docs.txt -# Noop # Base dependencies -pygments==2.16.1 +pygments==2.15.1 # Sphinx base and RTD theme. -sphinx==7.2.6 -sphinx_rtd_theme==2.0.0rc2 +sphinx==4.4.0 +sphinx_rtd_theme==1.1.1 # Sphinx extensions. # Code tabs extension to display codeblocks in different languages as tabs. -sphinx-tabs==3.4.1 +sphinx-tabs==3.4.0 # Adds a 'copy' button to the right of codeblocks. -sphinx-copybutton==0.5.2 +sphinx-copybutton==0.5.1 # Custom 404 error page (more useful than the default). -sphinx-notfound-page==1.0.0 +sphinx-notfound-page==0.8.3 # Adds Open Graph tags in the HTML `` tag. -sphinxext-opengraph==0.8.2 +sphinxext-opengraph==0.7.5 From 7bf77d8b5dbbff50fc631f119f02f39bea73e272 Mon Sep 17 00:00:00 2001 From: Max Hilbrunner Date: Fri, 10 Nov 2023 06:18:04 +0100 Subject: [PATCH 11/11] Update _extensions/godot_descriptions.py --- _extensions/godot_descriptions.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_extensions/godot_descriptions.py b/_extensions/godot_descriptions.py index 2e8cf4c4052..a59cf3321b5 100644 --- a/_extensions/godot_descriptions.py +++ b/_extensions/godot_descriptions.py @@ -106,7 +106,7 @@ def generate_description(app, pagename, templatename, context, doctree): '\n' ) - if not re.search('