[WIP] Fix docs search #3150
Open
[WIP] Fix docs search #3150
+16
−13
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Previous doc/README told users to install sphinx globally using the distribution's package manager. This commit changes that to only tell users to use pip and optionally make a python virtual environment.
Update Sphinx version used for docs from 6 to 8.2.3 to fix the search issues. Also forked the sphinxcontrib-domaintools dependency to fix a RuntimeError with python versions higher than 3.7
|
This worked fine locally but it seems to be that ReadTheDocs hijacks the sphinx search text-box (which works!) for their own search tool that doesn't work. Labeling the PR as WIP until I find a fix. |
|
At least until 2023, ReadTheDocs did not generate search indices for PR builds. This is also supported by the fact that the docs build for this PR took 3 minutes vs 10 minutes for the master branch. Unfortunately this all means that I have no way of testing if the search will actually work on the hosted docs or not. It does work locally though. |
|
Have you tried this yet? https://readthedocs-sphinx-search.readthedocs.io/en/latest/installation.html |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Updated the docs' python dependencies to fix the searching issues. Also had to fork one of the dependencies myself:
https://github.com/AmirhosseinPoolad/sphinxcontrib-domaintools
More information can be read in the commit messages.