Skip to content

Conversation

@jawad-khan
Copy link
Contributor

@jawad-khan jawad-khan commented Jan 20, 2026

Pull Request

Related issue

Fixes #1193

What does this PR do?

  • This PR fixes documentation build issue.

PR checklist

Please check if your PR fulfills the following requirements:

  • Did you use any AI tool while implementing this PR (code, tests, docs, etc.)? If yes, disclose it in the PR description and describe what it was used for. AI usage is allowed when it is disclosed.
  • Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)?
  • Have you read the contributing guidelines?
  • Have you made sure that the title is accurate and descriptive of the changes?

Thank you so much for contributing to Meilisearch!

Summary by CodeRabbit

  • Chores
    • Updated documentation build to rely on declared development dependencies instead of installing Sphinx and the theme explicitly in the CI workflow.
    • Added Sphinx and the Read the Docs theme to development dependencies so docs tooling is managed via the project's dev package configuration.

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

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 20, 2026

📝 Walkthrough

Walkthrough

Moved Sphinx-related dependency declarations from the GitHub Actions workflow to the repository Pipfile and reformatted exception message strings in a client HTTP module; documentation build steps in the workflow remain unchanged aside from the removed explicit installs.

Changes

Cohort / File(s) Summary
Workflow dependency removal
.github/workflows/documentation.yml
Removed explicit pip install sphinx sphinx_rtd_theme from the "Install dependencies" step; subsequent sphinx-apidoc and sphinx-build steps unchanged.
Pipfile dependency addition
Pipfile
Added sphinx and sphinx-rtd-theme under [dev-packages].
Client HTTP formatting
meilisearch/_httprequests.py
Reformatted triple-quoted f-strings into single-line f-string arguments for raised MeilisearchCommunicationError; no functional changes.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 I nudged Sphinx from workflow to Pipfile neat,
Tidied a string with a quiet heartbeat,
Docs still build where the steps remain,
A rabbit’s small hop, no fuss, no strain. 🥕📚

🚥 Pre-merge checks | ✅ 3 | ❌ 2
❌ Failed checks (2 warnings)
Check name Status Explanation Resolution
Out of Scope Changes check ⚠️ Warning The changes to meilisearch/_httprequests.py (string formatting adjustments in exception handling) appear unrelated to fixing the documentation build workflow specified in issue #1193. Remove the formatting changes in meilisearch/_httprequests.py as they are unrelated to the documentation build fix, or explain their necessity in the PR description.
Docstring Coverage ⚠️ Warning Docstring coverage is 50.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Linked Issues check ✅ Passed The PR successfully addresses issue #1193 by moving sphinx and sphinx-rtd-theme dependencies to Pipfile and adjusting the documentation workflow to rely on pipenv for installation, which resolves the documentation build failure.
Title check ✅ Passed The title 'Fixed sphinx dependency issue for documentation build' directly addresses the main change: moving sphinx and sphinx-rtd-theme dependencies from the workflow file to Pipfile.

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

✨ Finishing touches
  • 📝 Generate docstrings

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 and usage tips.

@jawad-khan jawad-khan changed the title fix: fixed documentation build Fixed sphinx depeendency issue for documentation build Jan 20, 2026
@jawad-khan jawad-khan changed the title Fixed sphinx depeendency issue for documentation build Fixed sphinx dependency issue for documentation build Jan 20, 2026
@jawad-khan
Copy link
Contributor Author

@Strift Can you please trigger workflow before merging this PR?

@jawad-khan
Copy link
Contributor Author

@Strift I tried it on my fork and it worked for me https://github.com/jawad-khan/meilisearch-python/actions/runs/21169618669

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.

Fix documentation build

1 participant