From 6562b80176653d65801584e19f933f82c0b3d914 Mon Sep 17 00:00:00 2001 From: Andreas Motl Date: Fri, 19 Dec 2025 01:13:29 +0100 Subject: [PATCH] Provide CrateDB reference documentation per `cratedb` intersphinx domain `cratedb` is much shorter than `crate-reference`, so this label saves keystrokes and uses less screen space. --- CHANGES.rst | 3 +++ docs/projects.rst | 2 +- src/crate/theme/rtd/conf/__init__.py | 2 +- 3 files changed, 5 insertions(+), 2 deletions(-) diff --git a/CHANGES.rst b/CHANGES.rst index 01a6623c..e13dd3c6 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -5,6 +5,9 @@ CHANGES Unreleased ---------- +- Breaking change: Started providing CrateDB reference documentation per + ``cratedb`` intersphinx domain. The label is much shorter than + ``crate-reference``, so it saves keystrokes and uses less screen space. 2025/12/17 0.44.0 ----------------- diff --git a/docs/projects.rst b/docs/projects.rst index d216ef0a..99a64940 100644 --- a/docs/projects.rst +++ b/docs/projects.rst @@ -20,7 +20,7 @@ CrateDB core ------------ - :ref:`guide:index` -- :ref:`crate-reference:index` +- :ref:`cratedb:index` CrateDB clients diff --git a/src/crate/theme/rtd/conf/__init__.py b/src/crate/theme/rtd/conf/__init__.py index 17399675..7c40cf4d 100644 --- a/src/crate/theme/rtd/conf/__init__.py +++ b/src/crate/theme/rtd/conf/__init__.py @@ -102,7 +102,7 @@ # CrateDB General 'guide': ('https://cratedb.com/docs/guide/', None), - 'crate-reference': ('https://cratedb.com/docs/crate/reference/en/latest/', None), + 'cratedb': ('https://cratedb.com/docs/crate/reference/en/latest/', None), # CrateDB Clients and Integrations 'crate-admin-ui': ('https://cratedb.com/docs/crate/admin-ui/en/latest/', None),