Skip to content

Fix compatibility with Sphinx <7 - #28

Merged
kai687 merged 2 commits into
algolia:mainfrom
kaxil:sphinx-compat
May 7, 2024
Merged

kai687 merged 2 commits into
algolia:mainfrom
kaxil:sphinx-compat

Conversation

@kaxil

@kaxil kaxil commented May 6, 2024 •

Copy link
Copy Markdown
Contributor

Console properties were moved under sphinx.utils.display in sphinx-doc/sphinx@8c5e701 which was released in Sphinx 7

This means sphinx_docsearch doesn't work with Sphinx <7 . This will make it comaptible with it since sphinx-docsearch technically supports those versions:

sphinx = [
{ version = "<7.2", python = ">=3.8,<3.9"},
{ version = "^7.2,<7.4", python = ">=3.9,<3.13"},
]

@kaxil kaxil changed the title Make it compatible with Sphinx <7 Fix compatibility with Sphinx <7 May 6, 2024
kaxil and others added 2 commits May 6, 2024 19:27
Console properties were moved under `sphinx.utils.display` in sphinx-doc/sphinx@8c5e701 which was released in Sphinx 7

This means `sphinx_docsearch` doesn't work with Sphinx <7 . This will make it comaptible with it.
@kai687 kai687 self-assigned this May 7, 2024
@kai687 kai687 added the bug Something isn't working label May 7, 2024
@kai687

kai687 commented May 7, 2024

Copy link
Copy Markdown
Collaborator

@kaxil Thanks for fixing this!

@kai687
kai687 merged commit 89f54af into algolia:main May 7, 2024
@kaxil
kaxil deleted the sphinx-compat branch May 7, 2024 23:03
@kaxil

kaxil commented May 7, 2024

Copy link
Copy Markdown
Contributor Author

Could you cut a new release @kai687 ?

@kai687

kai687 commented May 8, 2024

Copy link
Copy Markdown
Collaborator

I have some technical difficulties uploading to PyPI at the moment, otherwise I would have done it already. It'll take a week or two.

@kaxil

kaxil commented May 8, 2024

Copy link
Copy Markdown
Contributor Author

I have some technical difficulties uploading to PyPI at the moment, otherwise I would have done it already. It'll take a week or two.

aah no worries, thank you :)

@kaxil

kaxil commented May 8, 2024

Copy link
Copy Markdown
Contributor Author

I want to use it for Apache Airflow and we have Sphinx pinned at <7 for now, let's see if I am able to fix with my attempt to upgrade it here: apache/airflow#39449

@kai687

kai687 commented May 27, 2024

Copy link
Copy Markdown
Collaborator

@kaxil finally, I could release version 0.0.5 which contains your fix.

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

Labels

bug Something isn't working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants