- Notifications
You must be signed in to change notification settings - Fork5.7k
Removefuro-sphinx-search, and fix some docs#4826
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.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Pull Request Overview
This PR removes the outdatedfuro-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 | Removedfuro-sphinx-search from the docs dependencies |
| docs/source/conf.py | Deletedsphinx_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/furo-sphinx-search@v0.2.0.1",Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
…ethods on some classes
furo-sphinx-searchfuro-sphinx-search, and fix some docs4c61c4e intodoc-fixesUh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
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.