Skip to content

Commit 5d86e14

Browse files
ilevkivskyiJukkaL
authored andcommitted
Update install from source instructions: add --recurse-submodules (#4081)
Update the installation from source instructions to also copy typeshed (see #3867). Also minor formatting improvements.
1 parent c0c75cb commit 5d86e14

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

docs/source/getting_started.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ Getting started
66
Installation
77
************
88

9-
Mypy requires Python 3.3 or later. Once you've `installed Python 3 <https://www.python.org/downloads/>`_, you can install mypy with:
9+
Mypy requires Python 3.3 or later. Once you've `installed Python 3 <https://www.python.org/downloads/>`_,
10+
you can install mypy with:
1011

1112
.. code-block:: text
1213
@@ -15,10 +16,11 @@ Mypy requires Python 3.3 or later. Once you've `installed Python 3 <https://www
1516
Installing from source
1617
**********************
1718

18-
To install mypy from source, clone the github repository and then run pip install locally:
19+
To install mypy from source, clone the github repository and then run
20+
``pip install`` locally:
1921

2022
.. code-block:: text
2123
22-
$ git clone https://github.com/python/mypy.git
24+
$ git clone --recurse-submodules https://github.com/python/mypy.git
2325
$ cd mypy
2426
$ sudo python3 -m pip install --upgrade .

0 commit comments

Comments
 (0)