crate-docs-theme 0.50.3__tar.gz → 0.51.0.dev0__tar.gz

{crate_docs_theme-0.50.3/src/crate_docs_theme.egg-info → crate_docs_theme-0.51.0.dev0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: crate-docs-theme
-Version: 0.50.3
+Version: 0.51.0.dev0
 Summary: CrateDB Documentation Theme
 Home-page: https://github.com/crate/crate-docs-theme
 Author: Crate.IO GmbH
@@ -25,7 +25,7 @@ License-File: NOTICE
 Requires-Dist: furo==2025.12.19
 Requires-Dist: jinja2<4,>=3
 Requires-Dist: jupysql<0.12
-Requires-Dist: myst-nb<1.4
+Requires-Dist: myst-nb<1.5
 Requires-Dist: myst-parser[linkify]<6
 Requires-Dist: snowballstemmer<4
 Requires-Dist: sphinx<10,>=7.1

{crate_docs_theme-0.50.3 → crate_docs_theme-0.51.0.dev0}/setup.py

@@ -61,7 +61,7 @@ setup(
         "furo==2025.12.19",
         "jinja2>=3,<4",
         "jupysql<0.12",
-        "myst-nb<1.4",
+        "myst-nb<1.5",
         "myst-parser[linkify]<6",
         "snowballstemmer<4",
         "sphinx>=7.1,<10",

{crate_docs_theme-0.50.3 → crate_docs_theme-0.51.0.dev0}/src/crate/theme/rtd/__init__.py

@@ -23,9 +23,9 @@
 
 import os
 
-VERSION = (0, 50, 3)
+VERSION = (0, 51, 0)
 
-__version__ = ".".join(str(v) for v in VERSION) # + ".dev0"
+__version__ = ".".join(str(v) for v in VERSION)  + ".dev0"
 __version_full__ = __version__
 
 

{crate_docs_theme-0.50.3 → crate_docs_theme-0.51.0.dev0}/src/crate/theme/rtd/conf/__init__.py

@@ -100,6 +100,23 @@ sitemap_excludes = [
 ]
 
 # Configure intersphinx mapping
+#
+# TODO: Flip these to https://docs.cratedb.com/projects/... as part of the
+#       migration, but only *after* that domain actually serves content.
+#
+#       New URLs, for reference when the time comes:
+#         guide               -> https://docs.cratedb.com/projects/guide/
+#         crate-reference     -> https://docs.cratedb.com/projects/crate-reference/en/latest/
+#         crate-admin-ui      -> https://docs.cratedb.com/projects/crate-admin-ui/en/latest/
+#         crate-crash         -> https://docs.cratedb.com/projects/crate-crash/en/latest/
+#         crate-dbal          -> https://docs.cratedb.com/projects/dbal/en/latest/
+#         crate-jdbc          -> https://docs.cratedb.com/projects/jdbc/en/latest/
+#         crate-npgsql        -> https://docs.cratedb.com/projects/npgsql/en/latest/
+#         crate-pdo           -> https://docs.cratedb.com/projects/pdo/en/latest/
+#         crate-python        -> https://docs.cratedb.com/projects/python/en/latest/
+#         sqlalchemy-cratedb  -> https://docs.cratedb.com/projects/sqlalchemy-cratedb/
+#         cloud               -> https://docs.cratedb.com/projects/cloud/en/latest/
+#         cloud-cli           -> https://docs.cratedb.com/projects/cloud-cli/en/latest/
 intersphinx_mapping = {
 
     # CrateDB General
@@ -125,7 +142,6 @@ intersphinx_mapping = {
     'sql-99': ('https://sql-99.readthedocs.io/en/latest/', None),
 
     # CrateDB Docs
-    'crate-docs': ('https://crate-docs.readthedocs.io/en/latest/', None),
     'crate-docs-theme': ('https://crate-docs-theme.readthedocs.io/en/latest/', None),
 }
 
@@ -148,7 +164,7 @@ intersphinx_mapping = {
 #   So you can either treat it as 110, or, write your Descriptions to 300 but make sure the first 110
 #   is the critical part and still makes sense when it gets cut off.
 #   -- https://stackoverflow.com/questions/8914476/facebook-open-graph-meta-tags-maximum-content-length
-ogp_site_url = "https://cratedb.com/docs/"
+ogp_site_url = "https://docs.cratedb.com/"
 ogp_description_length = 300
 ogp_site_name = "CrateDB Documentation"
 ogp_image = "https://crate-docs-theme.readthedocs.io/en/latest/_static/images/cratedb-logo-h630.png"
@@ -291,43 +307,6 @@ def setup(app):
         # render it in `base.html` manually.
         config.html_context["custom_baseurl"] = html_baseurl_real
 
-    # Dynamically set the `proxied_api_host` context variable on a per-project level.
-    def set_proxied_api_host(app_inited):
-        try:
-
-            # Compute appropriate per-project `proxied_api_host`.
-            html_baseurl = app_inited.env.config.html_baseurl.strip("/")
-            proxied_api_host = html_baseurl + "/_"
-
-            # Propagate the `proxied_api_host` to different contexts by trial-and-error.
-            app_inited.env.config.proxied_api_host = proxied_api_host
-            app_inited.builder.config.proxied_api_host = proxied_api_host
-            app_inited.env.config.html_context["proxied_api_host"] = proxied_api_host
-            app_inited.builder.config.html_context["proxied_api_host"] = proxied_api_host
-            print(f"INFO: Adjusted `proxied_api_host` to {proxied_api_host}")
-
-        except Exception as ex:
-            print(f"ERROR: Unable to adjust `proxied_api_host`. Reason: {ex}")
-
-    # Dynamically adjust the `proxied_static_path` context variable on a per-project level.
-    # https://github.com/crate/crate-docs-theme/issues/342
-    def set_proxied_static_path(app_inited):
-        try:
-
-            # The default is `'proxied_static_path': "/_/static/"`.
-            # However, we want it to be, e.g., https://cratedb.com/docs/crate/howtos/_/static/
-            html_baseurl = app_inited.env.config.html_baseurl.strip("/")
-            proxied_static_path = f"{html_baseurl}/_/static/"
-
-            # Propagate the `proxied_api_host` to different contexts by trial-and-error.
-            app_inited.env.config.html_context["proxied_static_path"] = proxied_static_path
-            app_inited.builder.config.html_context["proxied_static_path"] = proxied_static_path
-
-            print(f"INFO: Adjusted `proxied_static_path` to {proxied_static_path}")
-
-        except Exception as ex:
-            print(f"ERROR: Unable to adjust `proxied_static_path`. Reason: {ex}")
-
     # Apply all attributes from `html_context_custom` to `html_context`.
     def apply_html_context_custom(app_inited):
         try:
@@ -350,8 +329,6 @@ def setup(app):
 
     # Customizations.
     app.connect("builder-inited", configure_self_hosted_on_path)
-    app.connect("builder-inited", set_proxied_api_host)
-    app.connect("builder-inited", set_proxied_static_path)
     app.connect("builder-inited", apply_html_context_custom)
 
     # Register stepper directive

{crate_docs_theme-0.50.3 → crate_docs_theme-0.51.0.dev0}/src/crate/theme/rtd/conf/cloud.py

@@ -22,11 +22,11 @@
 
 from crate.theme.rtd.conf import *
 
-# If you update the `project` value here, you must update it in the
-# `src/crate/theme/rtd/crate/sidebartoc.html` file or else Sphinx will not
-# expand the sidebar TOC for this project.
+# If you update the `project` value here, you must update it in
+# `src/crate/theme/rtd/sidebartoc.py` as well, or else the sidebar TOC will
+# not be expanded for this project.
 project = "CrateDB Cloud"
 html_title = project
 
-url_path = "docs/cloud"
-html_baseurl = "https://cratedb.com/%s/" % url_path
+url_path = "projects/cloud"
+html_baseurl = "https://docs.cratedb.com/%s/" % url_path

{crate_docs_theme-0.50.3 → crate_docs_theme-0.51.0.dev0}/src/crate/theme/rtd/conf/cloud_cli.py

@@ -22,11 +22,11 @@
 
 from crate.theme.rtd.conf import *
 
-# If you update the `project` value here, you must update it in the
-# `src/crate/theme/rtd/crate/sidebartoc.html` file or else Sphinx will not
-# expand the sidebar TOC for this project.
+# If you update the `project` value here, you must update it in
+# `src/crate/theme/rtd/sidebartoc.py` as well, or else the sidebar TOC will
+# not be expanded for this project.
 project = u"CrateDB Cloud: Croud CLI"
 html_title = project
 
-url_path = "docs/cloud/cli"
-html_baseurl = "https://cratedb.com/%s/" % url_path
+url_path = "projects/cloud-cli"
+html_baseurl = "https://docs.cratedb.com/%s/" % url_path

{crate_docs_theme-0.50.3 → crate_docs_theme-0.51.0.dev0}/src/crate/theme/rtd/conf/crate_admin_ui.py

@@ -22,11 +22,11 @@
 
 from crate.theme.rtd.conf import *
 
-# If you update the `project` value here, you must update it in the
-# `src/crate/theme/rtd/crate/sidebartoc.html` file or else Sphinx will not
-# expand the sidebar TOC for this project.
+# If you update the `project` value here, you must update it in
+# `src/crate/theme/rtd/sidebartoc.py` as well, or else the sidebar TOC will
+# not be expanded for this project.
 project = u"CrateDB: Admin UI"
 html_title = project
 
-url_path = "docs/crate/admin-ui"
-html_baseurl = "https://cratedb.com/%s/" % url_path
+url_path = "projects/crate-admin-ui"
+html_baseurl = "https://docs.cratedb.com/%s/" % url_path

{crate_docs_theme-0.50.3 → crate_docs_theme-0.51.0.dev0}/src/crate/theme/rtd/conf/crate_clients_tools.py

@@ -22,11 +22,11 @@
 
 from crate.theme.rtd.conf import *
 
-# If you update the `project` value here, you must update it in the
-# `src/crate/theme/rtd/crate/sidebartoc.html` file or else Sphinx will not
-# expand the sidebar TOC for this project.
+# If you update the `project` value here, you must update it in
+# `src/crate/theme/rtd/sidebartoc.py` as well, or else the sidebar TOC will
+# not be expanded for this project.
 project = u"CrateDB: Clients and Tools"
 html_title = project
 
-url_path = "docs/crate/clients-tools"
-html_baseurl = "https://cratedb.com/%s/" % url_path
+url_path = "projects/crate-clients-tools"
+html_baseurl = "https://docs.cratedb.com/%s/" % url_path

{crate_docs_theme-0.50.3 → crate_docs_theme-0.51.0.dev0}/src/crate/theme/rtd/conf/crate_crash.py

@@ -22,11 +22,11 @@
 
 from crate.theme.rtd.conf import *
 
-# If you update the `project` value here, you must update it in the
-# `src/crate/theme/rtd/crate/sidebartoc.html` file or else Sphinx will not
-# expand the sidebar TOC for this project.
+# If you update the `project` value here, you must update it in
+# `src/crate/theme/rtd/sidebartoc.py` as well, or else the sidebar TOC will
+# not be expanded for this project.
 project = u"CrateDB: Crash CLI"
 html_title = project
 
-url_path = "docs/crate/crash"
-html_baseurl = "https://cratedb.com/%s/" % url_path
+url_path = "projects/crate-crash"
+html_baseurl = "https://docs.cratedb.com/%s/" % url_path

crate_docs_theme-0.51.0.dev0/src/crate/theme/rtd/conf/crate_docs.py

@@ -0,0 +1,37 @@
+# -*- coding: utf-8; -*-
+#
+# Licensed to Crate (https://crate.io) under one or more contributor
+# license agreements.  See the NOTICE file distributed with this work for
+# additional information regarding copyright ownership.  Crate licenses
+# this file to you under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.  You may
+# obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
+# License for the specific language governing permissions and limitations
+# under the License.
+#
+# However, if you have executed another commercial license agreement
+# with Crate these terms will supersede the license and you may use the
+# software solely pursuant to the terms of the relevant commercial agreement.
+
+from crate.theme.rtd.conf import *
+
+# If you update the `project` value here, you must update it in
+# `src/crate/theme/rtd/sidebartoc.py` as well, or else the sidebar TOC will not
+# be expanded for this project.
+project = "CrateDB Documentation"
+html_title = project
+
+# This is the root project of the documentation site. It is served from the
+# web root of the custom domain, so it does not carry a path prefix, unlike
+# the subprojects below `/projects/<slug>/`.
+url_path = ""
+html_baseurl = "https://docs.cratedb.com/"
+
+# This is a project which is not versioned.
+version = ""

{crate_docs_theme-0.50.3 → crate_docs_theme-0.51.0.dev0}/src/crate/theme/rtd/conf/crate_howtos.py

@@ -22,11 +22,11 @@
 
 from crate.theme.rtd.conf import *
 
-# If you update the `project` value here, you must update it in the
-# `src/crate/theme/rtd/crate/sidebartoc.html` file or else Sphinx will not
-# expand the sidebar TOC for this project.
+# If you update the `project` value here, you must update it in
+# `src/crate/theme/rtd/sidebartoc.py` as well, or else the sidebar TOC will
+# not be expanded for this project.
 project = u"CrateDB: How-Tos"
 html_title = project
 
-url_path = "docs/crate/howtos"
-html_baseurl = "https://cratedb.com/%s/" % url_path
+url_path = "projects/crate-howtos"
+html_baseurl = "https://docs.cratedb.com/%s/" % url_path

{crate_docs_theme-0.50.3 → crate_docs_theme-0.51.0.dev0}/src/crate/theme/rtd/conf/crate_reference.py

@@ -22,11 +22,11 @@
 
 from crate.theme.rtd.conf import *
 
-# If you update the `project` value here, you must update it in the
-# `src/crate/theme/rtd/crate/sidebartoc.html` file or else Sphinx will not
-# expand the sidebar TOC for this project.
+# If you update the `project` value here, you must update it in
+# `src/crate/theme/rtd/sidebartoc.py` as well, or else the sidebar TOC will
+# not be expanded for this project.
 project = u"CrateDB: Reference"
 html_title = project
 
-url_path = "docs/crate/reference"
-html_baseurl = "https://cratedb.com/%s/" % url_path
+url_path = "projects/crate-reference"
+html_baseurl = "https://docs.cratedb.com/%s/" % url_path

{crate_docs_theme-0.50.3 → crate_docs_theme-0.51.0.dev0}/src/crate/theme/rtd/conf/crate_tutorials.py

@@ -22,11 +22,11 @@
 
 from crate.theme.rtd.conf import *
 
-# If you update the `project` value here, you must update it in the
-# `src/crate/theme/rtd/crate/sidebartoc.html` file or else Sphinx will not
-# expand the sidebar TOC for this project.
+# If you update the `project` value here, you must update it in
+# `src/crate/theme/rtd/sidebartoc.py` as well, or else the sidebar TOC will
+# not be expanded for this project.
 project = u"CrateDB: Tutorials"
 html_title = project
 
-url_path = "docs/crate/tutorials"
-html_baseurl = "https://cratedb.com/%s/" % url_path
+url_path = "projects/crate-tutorials"
+html_baseurl = "https://docs.cratedb.com/%s/" % url_path

{crate_docs_theme-0.50.3 → crate_docs_theme-0.51.0.dev0}/src/crate/theme/rtd/conf/cratedb_guide.py

@@ -22,14 +22,14 @@
 
 from crate.theme.rtd.conf import *
 
-# If you update the `project` value here, you must update it in the
-# `src/crate/theme/rtd/crate/sidebartoc.html` file or else Sphinx will not
-# expand the sidebar TOC for this project.
+# If you update the `project` value here, you must update it in
+# `src/crate/theme/rtd/sidebartoc.py` as well, or else the sidebar TOC will
+# not be expanded for this project.
 project = u"CrateDB: Guide"
 html_title = project
 
-url_path = "docs/guide"
-html_baseurl = "https://cratedb.com/%s/" % url_path
+url_path = "projects/guide"
+html_baseurl = "https://docs.cratedb.com/%s/" % url_path
 
 # This is a project which is not versioned.
 version = ""

{crate_docs_theme-0.50.3 → crate_docs_theme-0.51.0.dev0}/src/crate/theme/rtd/conf/dbal.py

@@ -22,11 +22,11 @@
 
 from crate.theme.rtd.conf import *
 
-# If you update the `project` value here, you must update it in the
-# `src/crate/theme/rtd/crate/sidebartoc.html` file or else Sphinx will not
-# expand the sidebar TOC for this project.
+# If you update the `project` value here, you must update it in
+# `src/crate/theme/rtd/sidebartoc.py` as well, or else the sidebar TOC will
+# not be expanded for this project.
 project = u"CrateDB DBAL"
 html_title = project
 
-url_path = "docs/dbal"
-html_baseurl = "https://cratedb.com/%s/" % url_path
+url_path = "projects/dbal"
+html_baseurl = "https://docs.cratedb.com/%s/" % url_path

{crate_docs_theme-0.50.3 → crate_docs_theme-0.51.0.dev0}/src/crate/theme/rtd/conf/doing_docs.py

@@ -22,11 +22,15 @@
 
 from crate.theme.rtd.conf import *
 
-# If you update the `project` value here, you must update it in the
-# `src/crate/theme/rtd/crate/sidebartoc.html` file or else Sphinx will not
-# expand the sidebar TOC for this project.
+# If you update the `project` value here, you must update it in
+# `src/crate/theme/rtd/sidebartoc.py` as well, or else the sidebar TOC will
+# not be expanded for this project.
 project = u"Doing Docs"
 html_title = project
 
-url_path = "docs/meta"
-html_baseurl = "https://cratedb.com/%s/" % url_path
+# NOTE: this project is not published anywhere at the moment -
+# `cratedb.com/docs/meta` returns 404 and there is no Read the Docs
+# project for it. The URL below is provisional, for if it is ever
+# added as a subproject.
+url_path = "projects/meta"
+html_baseurl = "https://docs.cratedb.com/%s/" % url_path

{crate_docs_theme-0.50.3 → crate_docs_theme-0.51.0.dev0}/src/crate/theme/rtd/conf/jdbc.py

@@ -22,11 +22,11 @@
 
 from crate.theme.rtd.conf import *
 
-# If you update the `project` value here, you must update it in the
-# `src/crate/theme/rtd/crate/sidebartoc.html` file or else Sphinx will not
-# expand the sidebar TOC for this project.
+# If you update the `project` value here, you must update it in
+# `src/crate/theme/rtd/sidebartoc.py` as well, or else the sidebar TOC will
+# not be expanded for this project.
 project = u"CrateDB JDBC"
 html_title = project
 
-# Vanilla Sphinx/RTD `html_baseurl`.
-html_baseurl = "https://cratedb.com/docs/jdbc/"
+url_path = "projects/jdbc"
+html_baseurl = "https://docs.cratedb.com/%s/" % url_path

{crate_docs_theme-0.50.3 → crate_docs_theme-0.51.0.dev0}/src/crate/theme/rtd/conf/npgsql.py

@@ -22,11 +22,13 @@
 
 from crate.theme.rtd.conf import *
 
-# If you update the `project` value here, you must update it in the
-# `src/crate/theme/rtd/crate/sidebartoc.html` file or else Sphinx will not
-# expand the sidebar TOC for this project.
+# If you update the `project` value here, you must update it in
+# `src/crate/theme/rtd/sidebartoc.py` as well, or else the sidebar TOC will
+# not be expanded for this project.
 project = u"CrateDB Npgsql"
 html_title = project
 
-# Vanilla Sphinx/RTD `html_baseurl`.
-html_baseurl = "https://cratedb.com/docs/npgsql/"
+# ARCHIVED: the crate-npgsql repository is archived and is not part of the
+# docs.cratedb.com migration.
+url_path = "projects/npgsql"
+html_baseurl = "https://docs.cratedb.com/%s/" % url_path

{crate_docs_theme-0.50.3 → crate_docs_theme-0.51.0.dev0}/src/crate/theme/rtd/conf/pdo.py

@@ -22,11 +22,11 @@
 
 from crate.theme.rtd.conf import *
 
-# If you update the `project` value here, you must update it in the
-# `src/crate/theme/rtd/crate/sidebartoc.html` file or else Sphinx will not
-# expand the sidebar TOC for this project.
+# If you update the `project` value here, you must update it in
+# `src/crate/theme/rtd/sidebartoc.py` as well, or else the sidebar TOC will
+# not be expanded for this project.
 project = u"CrateDB PDO"
 html_title = project
 
-url_path = "docs/pdo"
-html_baseurl = "https://cratedb.com/%s/" % url_path
+url_path = "projects/pdo"
+html_baseurl = "https://docs.cratedb.com/%s/" % url_path

{crate_docs_theme-0.50.3 → crate_docs_theme-0.51.0.dev0}/src/crate/theme/rtd/conf/python.py

@@ -22,11 +22,11 @@
 
 from crate.theme.rtd.conf import *
 
-# If you update the `project` value here, you must update it in the
-# `src/crate/theme/rtd/crate/sidebartoc.html` file or else Sphinx will not
-# expand the sidebar TOC for this project.
+# If you update the `project` value here, you must update it in
+# `src/crate/theme/rtd/sidebartoc.py` as well, or else the sidebar TOC will
+# not be expanded for this project.
 project = u"CrateDB Python"
 html_title = project
 
-url_path = "docs/python"
-html_baseurl = "https://cratedb.com/%s/" % url_path
+url_path = "projects/python"
+html_baseurl = "https://docs.cratedb.com/%s/" % url_path

{crate_docs_theme-0.50.3 → crate_docs_theme-0.51.0.dev0}/src/crate/theme/rtd/conf/sql_99.py

@@ -22,13 +22,22 @@
 
 from crate.theme.rtd.conf import *
 
-# If you update the `project` value here, you must update it in the
-# `src/crate/theme/rtd/crate/sidebartoc.html` file or else Sphinx will not
-# expand the sidebar TOC for this project.
+# If you update the `project` value here, you must update it in
+# `src/crate/theme/rtd/sidebartoc.py` as well, or else the sidebar TOC will
+# not be expanded for this project.
 project = u"SQL 99"
 html_title = project
 
-html_baseurl = "https://sql-99.readthedocs.io/"
+# TEMPORARY, for the docs.cratedb.com migration PoC.
+#
+# This project is normally standalone, hosted at https://sql-99.readthedocs.io/,
+# and therefore has no `url_path`. For the proof of concept, it is wired up as a
+# Read the Docs subproject of `crate-docs`, so it needs one.
+#
+# Revert both lines back to `html_baseurl = "https://sql-99.readthedocs.io/"`
+# once the setup has been proven.
+url_path = "projects/sql-99"
+html_baseurl = "https://docs.cratedb.com/%s/" % url_path
 
 # Disable the GitHub feedback area.
 html_context_custom.update({

{crate_docs_theme-0.50.3 → crate_docs_theme-0.51.0.dev0}/src/crate/theme/rtd/conf/sqlalchemy_cratedb.py

@@ -22,14 +22,14 @@
 
 from crate.theme.rtd.conf import *
 
-# If you update the `project` value here, you must update it in the
-# `src/crate/theme/rtd/crate/sidebartoc.html` file or else Sphinx will not
-# expand the sidebar TOC for this project.
+# If you update the `project` value here, you must update it in
+# `src/crate/theme/rtd/sidebartoc.py` as well, or else the sidebar TOC will
+# not be expanded for this project.
 project = u"SQLAlchemy Dialect"
 html_title = project
 
-url_path = "docs/sqlalchemy-cratedb"
-html_baseurl = "https://cratedb.com/%s/" % url_path
+url_path = "projects/sqlalchemy-cratedb"
+html_baseurl = "https://docs.cratedb.com/%s/" % url_path
 
 # This is a project which is not versioned.
 version = ""

{crate_docs_theme-0.50.3 → crate_docs_theme-0.51.0.dev0}/src/crate/theme/rtd/conf/theme.py

@@ -23,10 +23,12 @@
 from crate.theme.rtd.conf import *
 
 # You can change the `project` value to anything you want because
-# `src/crate/theme/rtd/crate/sidebartoc.html` does not have a menu item for
+# `src/crate/theme/rtd/sidebartoc.py` does not have a menu item for
 # this project.
 project = "CrateDB documentation theme"
 html_title = project
 
-url_path = "docs/theme"
-html_baseurl = "https://cratedb.com/%s/" % url_path
+# The theme's own documentation is served from its own Read the Docs
+# domain, not as a subproject of `crate-docs`, so it carries no
+# `projects/` path and needs its own base URL.
+html_baseurl = "https://crate-docs-theme.readthedocs.io/"

{crate_docs_theme-0.50.3 → crate_docs_theme-0.51.0.dev0}/src/crate/theme/rtd/crate/page.html

@@ -11,12 +11,6 @@
   {%- endtrans -%}
 </a>
 
-{% block announcement %}
-<div class="sb-announcement">
-  {% include "sections/announcement.html" %}
-</div>
-{% endblock announcement %}
-
 {% block header %}
 <header class="sb-header header-nav" id="top">
   <div class="sb-header__inner sb-page-width">

{crate_docs_theme-0.50.3 → crate_docs_theme-0.51.0.dev0}/src/crate/theme/rtd/crate/search.html

@@ -19,15 +19,23 @@
 {{ super() }}
 <meta name="robots" content="noindex" />
 
+{%- if project == 'SQL 99' %}
+{# Sphinx's built-in search. `searchindex.js` calls Search.setIndex() itself, so
+   it only has to be loaded; `searchtools.js` then renders into #search-results. #}
+<script src="{{ pathto('searchindex.js', 1) }}" defer="defer"></script>
+{%- else %}
 <!-- Algolia instansearch stylesheet -->
 <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/instantsearch.css@8.2.0/themes/satellite-min.css">
+{%- endif %}
 {%- endblock head_extra -%}
 
-{% if project == 'SQL 99' %}
-<script type="text/javascript">
-  jQuery(function() { Search.loadIndex("{{ pathto('searchindex.js', 1) }}"); });
-</script>
-{% endif %}
+{%- block scripts -%}
+{{ super() }}
+{%- if project == 'SQL 99' %}
+<script src="{{ pathto('_static/searchtools.js', 1) }}"></script>
+<script src="{{ pathto('_static/language_data.js', 1) }}"></script>
+{%- endif %}
+{%- endblock scripts -%}
 
 
 {% block content %}
@@ -47,17 +55,17 @@
 
     {% if project == 'SQL 99' %}
 
-    <form class="form-search" action="" method="get" class="cr-nojs-hide">
-      <input type="text" name="q" class="input-medium search-query" placeholder="Search documentation..." autofocus>
+    <form class="form-search cr-nojs-hide" action="" method="get">
+      <input type="text" name="q" class="input-medium search-query"
+             placeholder="Search documentation..."
+             aria-labelledby="search-documentation"
+             autocomplete="off" autocorrect="off" autocapitalize="off"
+             spellcheck="false" autofocus>
       <button type="submit" class="btn btn-primary">{{ _('search') }}</button>
-      <!-- <span id="search-progress" style="padding-left: 10px"></span> -->
+      {# No #search-progress node on purpose: it is empty except for a brief
+         "Preparing search..." and would otherwise leave a permanent gap next
+         to the button. searchtools.js checks for it and skips it if absent. #}
     </form>
-    {% if search_performed %}
-      <h2>{{ _('Search Results') }}</h2>
-      {% if not search_results %}
-        <p>{{ _('Your search did not match any results.') }}</p>
-      {% endif %}
-    {% endif %}
     <noscript>
       <div id="fallback" class="admonition warning">
       <p>
@@ -66,20 +74,8 @@
       </p>
       </div>
     </noscript>
-    {% if search_results %}
-    <div id="search-results">
-      <ul>
-      {% for href, caption, context in search_results %}
-        <li class="card">
-          <div class="card-block">
-            <h3 class="card-title"><a href="{{ pathto(item.href) }}">{{ caption }}</a></h3>
-            <div class="context">{{ context|e }}</div>
-          </div>
-        </li>
-      {% endfor %}
-      </ul>
-    </div>
-    {% endif %}
+    {# searchtools.js reads ?q= and renders the results in here. #}
+    <div id="search-results"></div>
 
     {% else %}
 
@@ -101,9 +97,11 @@
 
 {% block footer_content %}
 {{ super() }}
+{%- if project != 'SQL 99' %}
 <!-- Algolia Instantsearch  -->
 <script src="https://cdn.jsdelivr.net/npm/algoliasearch@4.23.3/dist/algoliasearch-lite.umd.js"></script>
 <script src="https://cdn.jsdelivr.net/npm/instantsearch.js@4.69.0/dist/instantsearch.production.min.js"></script>
+{%- endif %}
 {% endblock footer_content %}