Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

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

オープン 初心者向け
#617 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
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時間
マージ済み PR(30日)
4

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

pytest-dev/pytest-cov のほかの issue

pytest-dev/pytest-cov の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。