[docs feature] keep more readthedocs versions around

Open
#19,922 5 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
45/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Domain
documentation

Research direction

Read the Read the Docs versions documentation linked in the issue, then inspect the repository's existing Read the Docs configuration. Enable selectable older documentation versions and configure them to use tags rather than branches; done means older mypy documentation is available on mypy.readthedocs.io without relying on stale branches.

Written by the indexing model from the issue text.

Description

documentation topic-developer

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

Dominant language
Python
Stars
20.6k
Forks
3.3k
Avg merge
1d 18h
Merged PRs (30d)
54

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from python/mypy

All issues in python/mypy

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.