Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
# Documentation on Read the Docs is intended to be built from released
# git tags to support versioned documentation.

version: 2

Expand Down
14 changes: 14 additions & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -117,3 +117,17 @@ Indices and tables

* :ref:`genindex`
* :ref:`search`

Documentation versions
----------------------

Mypy documentation on Read the Docs is built from released git tags.
This allows users to browse documentation corresponding to older
released versions of mypy.

Using git tags for documentation versions avoids relying on long-lived
maintenance branches and makes it easier to remove stale branches while
still preserving historical documentation.

Older documentation versions are kept available to support users
working with pinned or legacy mypy releases.