Remove furo-sphinx-search, and fix some docs#4826
Merged
Bibo-Joshi merged 7 commits intodoc-fixesfrom Jun 19, 2025
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR removes the outdated furo-sphinx-search extension and cleans up related directives in the documentation to address build warnings and prepare for RTD search addons.
- Remove
furo-sphinx-searchdependency frompyproject.toml - Drop
sphinx_search.extensionfromconf.py - Remove obsolete
:inherited-members: TelegramObjectdirectives in three RST files
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| pyproject.toml | Removed furo-sphinx-search from the docs dependencies |
| docs/source/conf.py | Deleted sphinx_search.extension from the extensions list |
| docs/source/telegram.transactionpartner.rst | Removed :inherited-members: TelegramObject |
| docs/source/telegram.startransactions.rst | Removed :inherited-members: TelegramObject |
| docs/source/telegram.startransaction.rst | Removed :inherited-members: TelegramObject |
Comments suppressed due to low confidence (2)
docs/source/conf.py:53
- Since
furo-sphinx-searchwas removed, add and configure the ReadTheDocs search extension (e.g.,readthedocs-searchor enablesphinx_rtd_theme’s search) so that full-text search is restored.
"sphinx_search.extension",
pyproject.toml:118
- Consider adding a CI step that builds the documentation and fails on warnings or errors, ensuring future changes don’t reintroduce broken extensions or stale directives.
"furo-sphinx-search @ git+https://github.com/harshil21/[email protected]",
…les which need it
Bibo-Joshi
reviewed
Jun 15, 2025
…ethods on some classes
harshil21
changed the title
furo-sphinx-searchfuro-sphinx-search, and fix some docs
Bibo-Joshi
approved these changes
Jun 19, 2025
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
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Search as you type has not been working for a long time, we should probably enable the rtd addons - #4387
There are also many warnings while building docs, looks like the strict flag doesn't work? This PR fixes a few at least, I can't seem to figure out why the others fail...
Also fixes a few docs, where methods of the
objectclass were listed out.