crate · bmunkholm · Jun 23, 2025 · Jun 23, 2025 · Jun 23, 2025 · Jun 23, 2025
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -24,6 +24,9 @@ jobs:
 
     steps:
       - uses: actions/checkout@v4
+        with:
+          fetch-depth: 50
+          ref: main
       - name: Set up Python
         uses: actions/setup-python@v5
         with:

diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -11,6 +11,9 @@ build:
   os: "ubuntu-22.04"
   tools:
     python: "3.11"
+  jobs:
+    post_checkout:
+      - git fetch --unshallow || true
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:

diff --git a/README.rst b/README.rst
@@ -1,4 +1,4 @@
-============================
+ ============================
 CrateDB Documentation System
 ============================
 

diff --git a/docs/conf.py b/docs/conf.py
@@ -1 +1,3 @@
 from crate.theme.rtd.conf.theme import *
+
+#suppress_warnings = ['git.too_shallow']
Original file line number	Diff line number	Diff line change
		@@ -1 +1,3 @@
		from crate.theme.rtd.conf.theme import *

		#suppress_warnings = ['git.too_shallow']
Copy link Member amotl Jun 23, 2025 • edited Loading Choose a reason for hiding this comment The reason will be displayed to describe this comment to others. Learn more. This one will just apply to the documentation of this tool repository in isolation, nothing else. If we want to roll out a Sphinx setting across all documentation projects, crate-docs-theme is the right place. bmunkholm reacted with thumbs up emoji Copy link Member amotl Jun 23, 2025 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others. Learn more. I think suppressing warnings should only happen as a very last resort, of course always depending on circumstances. Copy link Member amotl Jun 24, 2025 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others. Learn more. Let's remove this, merge, and then spread it out to other repositories? Copy link Contributor Author bmunkholm Jun 24, 2025 • edited Loading Choose a reason for hiding this comment The reason will be displayed to describe this comment to others. Learn more. There are still a few open questions: What depth is needed when fetching? Do we get any value out of the new sphinx-sitemap? I.e. dates on when a page was updated? Is that for end users or search? Can we disable this by configuration (assuming we don't need/want it). I remember seeing something, but don't recall exact config option right now... Will this be fixed in sphinx-sitemap itself? Therefore itt seems very attractive to be able to fix this temporarily for all docs builds just one place, so I would suggest to pin sphinx-sitemap in crate-docs-theme instead for now. Copy link Member amotl Jun 25, 2025 • edited Loading Choose a reason for hiding this comment The reason will be displayed to describe this comment to others. Learn more. Hi Brian. It seems very attractive to be able to fix this temporarily for all docs builds just one place, so I would suggest to crate/crate-docs-theme#611 instead for now. That's absolutely way to go in such a situation, thank you so much.