python / python/mypy

[docs feature] keep more readthedocs versions around

オープン
#19,922 コメント 5 件 リアクション 1 件 担当者 0 名 GitHub で見る

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

documentation topic-developer
主要言語
Python
スター
20.6k
フォーク
3.3k
PR マージ指標
PR 指標を取得中

説明

Currently on https://mypy.readthedocs.io/ you can switch between stable and latest versions of the documentation, which is very convenient. However, what if you want to look at an older version of the documentation, such as if your installed mypy version is older or perhaps you want to track down when something changed in mypy history? Not so convenient now, because you can't go look at old versions of the documentation. However, this seems to be a feature that one can enable in readthedocs, called (in general) "versions" https://docs.readthedocs.com/platform/latest/versions.html and it seems to be free for community users as well https://about.readthedocs.com/pricing/#/community ("Documentation versioning", here, not to be confused with "build concurrency"), so, that seems like a useful thing to do.

On another note, the old versions should be configured to use tags not branches, so that we can get rid of stale branches à la https://github.com/python/mypy/issues/19795

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

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

調査の方向性

Issue にリンクされている Read the Docs の versions ドキュメントを読み、その後、リポジトリに既存の Read the Docs 設定を確認します。選択可能な古いドキュメントバージョンを有効にし、ブランチではなくタグを使用するよう設定します。古い mypy のドキュメントが、古いブランチに依存せず mypy.readthedocs.io で利用できれば完了です。

索引モデルが issue の本文から書いたものです。

評価

領域
documentation
issue の種類
ドキュメント
難易度
3/5
見積もり時間
1〜2日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
45/100

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

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