Adapt to RTD Addons

未关闭
#4,387 2 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 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 内容生成。

描述

⚙️ documentation

Apart from the changes in #4386, some additional changes might be necessary to adapt to RTD Addons once our furo theme has adapted. Punshlines:

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

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

python-telegram-bot/python-telegram-bot 的其他 Issue

查看 python-telegram-bot/python-telegram-bot 的全部 Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。