python / python/peps

PEP 12: Add list of intersphinx mappings

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

还没有人认领这个 Issue。

主要语言
reStructuredText
星标
5k
派生
1.8k
平均合并
2 天 4 小时
30 天内合并 PR
25

描述

PEP 12 is very helpful in writing PEPs and has a section on intersphinx. However, to know the available intersphinx mappings, one has to know where to look in the sphinx configuration.

I think it would be useful to include the list directly in PEP 12.

Alternatively, if that is considered to be at too high a risk for getting outdated, one could add an explanation on where to find it.

贡献指南

打开贡献指南

从这里开始

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

调研方向

首先定位 PEP 12 以及 issue 中引用的 Sphinx 配置。确认 intersphinx 映射维护在哪里,然后使用该列表更新 PEP 12,或说明读者可以在哪里找到该列表;完成的标准是:无需预先了解配置知识即可发现可用的映射。

由索引模型根据 Issue 内容生成。

评估

技术栈
python
领域
documentation
Issue 类型
文档
难度
2/5
预计耗时
1-3 小时
活跃度
停滞
描述清晰度
基本清楚
新手友好度
48/100

把新 issue 发到你的邮箱

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