Skip to content

docs: update theme 1.9.3 - #977

Open
dgarcia360 wants to merge 1 commit into
scylladb:scylla-4.xfrom
dgarcia360:update-theme-193
Open

docs: update theme 1.9.3#977
dgarcia360 wants to merge 1 commit into
scylladb:scylla-4.xfrom
dgarcia360:update-theme-193

Conversation

@dgarcia360

@dgarcia360 dgarcia360 commented Jul 28, 2026

Copy link
Copy Markdown

Replaces #961

Updates docs theme to the latest version.

@coderabbitai

coderabbitai Bot commented Jul 28, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

The documentation build configuration now requires sphinx-scylladb-theme version 1.9.3 or newer. The configuration reference README replaces its previous inline link with a Sphinx :doc: cross-reference to the configuration index.

Possibly related PRs

Suggested reviewers: dkropachev

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title is concise and accurately summarizes the main change: updating the docs theme to 1.9.3.
Description check ✅ Passed The description is clearly related to the docs theme update and the referenced replacement PR.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@manual/core/configuration/reference/README.rst`:
- Line 27: Update the configuration cross-reference in the README documentation
to target the existing /manual/core/configuration/README document instead of the
nonexistent configuration index target, preserving the surrounding explanatory
link text.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 386b0682-db1b-44d1-ac3a-66fcc27e2694

📥 Commits

Reviewing files that changed from the base of the PR and between 8750e68 and 4f82a90.

⛔ Files ignored due to path filters (1)
  • docs/uv.lock is excluded by !**/*.lock
📒 Files selected for processing (2)
  • docs/pyproject.toml
  • manual/core/configuration/reference/README.rst

``core/src/main/resources``).

See the `configuration page <../>`_ for more explanations.
See the :doc:`configuration page </manual/core/configuration/index>` for more explanations.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
fd -HI '^(README\.md|index\.(rst|md))$' manual/core/configuration
rg -n 'source_suffix|master_doc|root_doc|manual/core/configuration' docs manual -g '*.py' -g '*.toml' -g '*.rst'

Repository: scylladb/java-driver

Length of output: 438


🏁 Script executed:

#!/bin/bash
set -euo pipefail

echo "== repository layout around configuration docs =="
git ls-files 'manual/core/configuration/*' 'docs/source/conf.py' 'mkdocs.yml' '*.yml' '*.yaml' '*.toml' | sed -n '1,200p'

echo
echo "== docs/source/conf.py relevant settings =="
sed -n '1,120p' docs/source/conf.py

echo
echo "== Sphinx autodoc/setup / include manifests mentioning manual/core/configuration =="
rg -n 'manual/core/configuration|configuration/reference|Sphinx|sphinx|toctree|include|conf\.py' -g '*.py' -g '*.rst' -g '*.yml' -g '*.yaml' -g '*.toml' -g '*.cfg' docs manual .github 2>/dev/null | sed -n '1,240p'

echo
echo "== Markdown doc title/heading if present =="
sed -n '1,80p' manual/core/configuration/README.md

Repository: scylladb/java-driver

Length of output: 9121


Point the configuration cross-reference at the actual doc file.

manual/core/configuration/README.md exists, but there is no manual/core/configuration/index document or corresponding Sphinx alias. This :doc: reference should target </manual/core/configuration/README> so it doesn’t become an unresolved “missing reference” warning.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@manual/core/configuration/reference/README.rst` at line 27, Update the
configuration cross-reference in the README documentation to target the existing
/manual/core/configuration/README document instead of the nonexistent
configuration index target, preserving the surrounding explanatory link text.

@annastuchlik

Copy link
Copy Markdown

@nikagra @dkropachev Please merge.

@nikagra nikagra left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approving, but rebase is welcome

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants