python / python/docs-community

Host the Python docs on ReadTheDocs

未关闭
#5 40 条评论 4 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

discussion
主要语言
Makefile
星标
55
派生
26
PR 合并指标
30 天内没有已合并 PR

描述

From time to time the discussion arise about moving docs.python.org to readthedocs, there's even an experimental python.readthedocs.io.

I think there's many pros and cons of using readthedocs.

I'd personally be in favor of it if we (the PSF) support them (the cpython Doc is a big one with a lot of traffic, it take around 24h of CPU to build all versions × languages with all PDF A4, PDF letter, HTML, plaintext, epub).

In the other hand it's not an easy task, among other things docs.python.org is not only about generating the docs but also hosting history:

贡献指南

这个仓库没有索引到贡献指南

从这里开始

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

调研方向

先审查当前 docs.python.org 的托管和构建流程,然后将其与实验性的 python.readthedocs.io 设置进行比较。特别关注发布历史、Python 2.0 及其他旧版本,以及所述的多版本、多语言和多格式构建负载。完成标准是制定出一份具体的迁移计划,在保留这些要求的同时解决 PSF 与托管之间的权衡。

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

评估

技术栈
python
领域
documentation
Issue 类型
功能
难度
5/5
预计耗时
一周以上
活跃度
停滞
描述清晰度
需要澄清
新手友好度
25/100

把新 issue 发到你的邮箱

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