Adapt to RTD Addons
还没有人认领这个 Issue。
评估
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 新手友好度
- 35/100
- Issue 类型
- 文档
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
调研方向
Start by checking Furo issue #795 and the Read the Docs Addons guidance, then inspect the type-as-you-search implementation and the referenced lines in .readthedocs.yml. Test the RTD build and confirm whether search still works and whether the existing configuration is still needed, including compatibility handling if required.
由索引模型根据 Issue 内容生成。
描述
Apart from the changes in #4386, some additional changes might be necessary to adapt to RTD Addons once our furo theme has adapted. Punshlines:
- the switch needs to happen by 2024-10-07
- furo tracks the transition in https://github.com/pradyunsg/furo/issues/795. I've already subscribed to that thread.
I recommend that we wait for the issue to be closed and then test out what we need to change. In particular I expect that we might need to
- check if our type-as-you-search implementation still works and if we can replace it by the new native feature
- Check if this part of our rtd build still works/is still needed
If furo is ready before 2024-10-07 I recommend that we try switching early
If furo is not ready at 2024-10-07, we should try (preferably a bit before) to use sphinx-build-compatiblity to manually enable backward compatibility. Or at least check if that's necessary.
- 主要语言
- Python
- 星标
- 29.5k
- 派生
- 6.2k
- 平均合并
- 2 天 1 小时
- 30 天内合并 PR
- 14
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
python-telegram-bot/python-telegram-bot 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 84/100
python-telegram-bot/python-telegram-bot#5315 · 2 条评论 ·
-
⚙️ documentation
python-telegram-bot/python-telegram-bot#5309 · 已指派 1 人 ·
-
🛠 breaking 🛠 refactor
难度 5/5 一周以上 新手友好度 25/100
python-telegram-bot/python-telegram-bot#5279 · 7 条评论 ·
-
⚙️ type-hinting 📋 help-wanted
难度 5/5 一周以上 新手友好度 30/100
python-telegram-bot/python-telegram-bot#5272 · 3 条评论 ·
-
🔌 bug 🔗 github-actions
python-telegram-bot/python-telegram-bot#5270 · 3 条评论 · 已指派 1 人 ·