Fix missing dependency in docs

[michaelboulton]

Fix not actually including the jquery dependency

Closes #995

Summary by CodeRabbit

• Chores
  • Enhanced documentation build infrastructure to support improved functionality.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

📝 Walkthrough

Walkthrough

A single-line addition to the Sphinx configuration file enabling the sphinxcontrib.jquery extension, addressing jQuery availability in the documentation build system.

Changes

Cohort / File(s)	Summary
Sphinx Extension Configuration docs/source/conf.py	Added sphinxcontrib.jquery to the extensions list to provide jQuery support for Sphinx-generated documentation.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately describes the main change: adding the missing sphinxcontrib.jquery dependency to fix documentation build issues.
Linked Issues check	✅ Passed	The pull request directly addresses issue #995 by adding the sphinxcontrib.jquery extension, which restores the jQuery dependency required for search functionality.
Out of Scope Changes check	✅ Passed	The change is narrowly scoped to adding sphinxcontrib.jquery to the Sphinx extensions list, which is directly aligned with resolving the jQuery error in issue #995.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch fix/update-docs

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

🤖 Fix all issues with AI agents

In `@docs/source/conf.py`:
- Line 40: The conf.py enables the "sphinxcontrib.jquery" extension but the
package isn't declared as a dependency; update the docs dependency group in
pyproject.toml to include the distribution name "sphinxcontrib-jquery"
(alongside existing entries like "sphinx>=7,<8", "sphinx_rtd_theme", etc.) so
the extension referenced by the "sphinxcontrib.jquery" entry in
docs/source/conf.py will be installed during documentation builds.

[coderabbitai]

⚠️ Potential issue | 🔴 Critical

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Description: Check if sphinxcontrib-jquery is listed in any requirements or dependency files.

# Search for sphinxcontrib-jquery in requirements files
echo "=== Searching requirements files ==="
fd -e txt -e in 'requirements' --exec grep -l -i 'sphinxcontrib' {} \; 2>/dev/null || echo "No matches in requirements files"

# Search in pyproject.toml
echo -e "\n=== Checking pyproject.toml ==="
if [ -f "pyproject.toml" ]; then
    grep -i 'sphinxcontrib' pyproject.toml || echo "Not found in pyproject.toml"
else
    echo "pyproject.toml not found"
fi

# Search in setup.py or setup.cfg
echo -e "\n=== Checking setup files ==="
for f in setup.py setup.cfg; do
    if [ -f "$f" ]; then
        echo "--- $f ---"
        grep -i 'sphinxcontrib' "$f" || echo "Not found in $f"
    fi
done

# Search in docs directory for any requirements file
echo -e "\n=== Checking docs directory ==="
find docs -name '*requirements*' 2>/dev/null -exec cat {} \; || echo "No requirements file in docs/"

# List all files that might contain dependencies
echo -e "\n=== All dependency-related files ==="
fd '(requirements|setup|pyproject|poetry|pipfile)' . --type f 2>/dev/null | head -20

Repository: taverntesting/tavern

Length of output: 402

---

🏁 Script executed:

cat pyproject.toml | head -100

Repository: taverntesting/tavern

Length of output: 2158

---

🏁 Script executed:

grep -A 30 'dependency-groups' pyproject.toml | grep -A 50 'docs'

Repository: taverntesting/tavern

Length of output: 46

---

🏁 Script executed:

sed -n '/\[dependency-groups\]/,$p' pyproject.toml

Repository: taverntesting/tavern

Length of output: 4516

---

The extension configuration is correct, but the package dependency is missing.

Adding sphinxcontrib.jquery to conf.py is the proper solution for the jQuery issue. However, the package must also be added to the documentation dependencies in pyproject.toml for the extension to be installed during the build.

Add sphinxcontrib-jquery to the docs dependency group in pyproject.toml:

Required change

docs = [
    "sphinx>=7,<8",
    "sphinx_rtd_theme",
    "recommonmark",
    "commonmark",
    "docutils",
    "pygments",
    "sphinx-markdown-tables",
    "sphinxcontrib-jquery",
]

Without this dependency, the documentation build will fail when Sphinx attempts to load the extension.

🤖 Prompt for AI Agents

In `@docs/source/conf.py` at line 40, The conf.py enables the
"sphinxcontrib.jquery" extension but the package isn't declared as a dependency;
update the docs dependency group in pyproject.toml to include the distribution
name "sphinxcontrib-jquery" (alongside existing entries like "sphinx>=7,<8",
"sphinx_rtd_theme", etc.) so the extension referenced by the
"sphinxcontrib.jquery" entry in docs/source/conf.py will be installed during
documentation builds.