[docs] Merge overview/readme and index documents in Sphinx

未关闭 适合新手
#617 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

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

调研方向

首先检查生成 index.html 和 readme.html 页面的 Sphinx 文档源文件,然后跟踪侧边栏目录的配置方式。合并概览和索引内容,使 readme 页面成为着陆页,并验证构建后的文档不再呈现冗余的独立索引页面。

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

描述

I think that https://pytest-cov.readthedocs.io/en/latest/index.html should be https://pytest-cov.readthedocs.io/en/latest/readme.html. This is how most projects are set up. The ToC is already present in the sidebar, I don't think it's very useful to have a page with just that. Plus, it's a bit confusing UX-wise.

主要语言
Python
星标
2.1k
派生
253
平均合并
12 天 4 小时
30 天内合并 PR
4

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

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

pytest-dev/pytest-cov 的其他 Issue

查看 pytest-dev/pytest-cov 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

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