Skip to content

Commit b35bb6a

Browse files
committed
docs: clarify Read the Docs versioning and retention of older versions
1 parent 7285830 commit b35bb6a

File tree

2 files changed

+16
-0
lines changed

2 files changed

+16
-0
lines changed

.readthedocs.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Read the Docs configuration file
22
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
3+
# Documentation on Read the Docs is intended to be built from released
4+
# git tags to support versioned documentation.
35

46
version: 2
57

docs/source/index.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,3 +117,17 @@ Indices and tables
117117

118118
* :ref:`genindex`
119119
* :ref:`search`
120+
121+
Documentation versions
122+
----------------------
123+
124+
Mypy documentation on Read the Docs is built from released git tags.
125+
This allows users to browse documentation corresponding to older
126+
released versions of mypy.
127+
128+
Using git tags for documentation versions avoids relying on long-lived
129+
maintenance branches and makes it easier to remove stale branches while
130+
still preserving historical documentation.
131+
132+
Older documentation versions are kept available to support users
133+
working with pinned or legacy mypy releases.

0 commit comments

Comments
 (0)