Skip to content

Commit cd71df2

Browse files
authored
Modified
1 parent 1593613 commit cd71df2

File tree

2 files changed

+16
-1
lines changed

2 files changed

+16
-1
lines changed

.readthedocs.yaml

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

67
build:

docs/source/index.rst

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

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

0 commit comments

Comments
 (0)