Skip to content

Fixed sphinx dependency issue for documentation build #1197

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jawad-khan wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Fixed sphinx dependency issue for documentation build #1197

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
58231c8
fix: fixed documentation build
jawad-khan Jan 20, 2026
8272b11
fix: fixed tests
jawad-khan Jan 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions .github/workflows/documentation.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,6 @@ jobs:
- name: Install dependencies
run: |
pipenv --python $(which python) install --dev
pipenv install sphinx
pipenv install sphinx_rtd_theme
- name: Build docs
run: |
pipenv run sphinx-apidoc -f -o docs meilisearch/
Expand Down
2 changes: 2 additions & 0 deletions Pipfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ tomli = {version = "*", markers="python_version < '3.11'"}
wrapt = {version = "*", markers="python_version < '3.11'"}
dill = {version = "*"}
pytest-cov = "*"
sphinx = "*"
sphinx-rtd-theme = "*"

[packages]
requests = "*"
Expand Down
12 changes: 4 additions & 8 deletions meilisearch/_httprequests.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,12 +83,10 @@ def send_request(
raise MeilisearchCommunicationError(str(err)) from err
except requests.exceptions.InvalidSchema as err:
if "://" not in self.config.url:
raise MeilisearchCommunicationError(
f"""
raise MeilisearchCommunicationError(f"""
Invalid URL {self.config.url}, no scheme/protocol supplied.
Did you mean https://{self.config.url}?
"""
) from err
""") from err

raise MeilisearchCommunicationError(str(err)) from err

Expand Down Expand Up @@ -203,12 +201,10 @@ def post_stream(
raise MeilisearchApiError(str(err), response) from err
except requests.exceptions.InvalidSchema as err:
if "://" not in self.config.url:
raise MeilisearchCommunicationError(
f"""
raise MeilisearchCommunicationError(f"""
Invalid URL {self.config.url}, no scheme/protocol supplied.
Did you mean https://{self.config.url}?
"""
) from err
""") from err

raise MeilisearchCommunicationError(str(err)) from err

Expand Down