Skip to content

Update install from source instructions: add --recurse-submodules #4081

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 9, 2017
Merged
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
8 changes: 5 additions & 3 deletions docs/source/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ Getting started
Installation
************

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

.. code-block:: text

Expand All @@ -15,10 +16,11 @@ Mypy requires Python 3.3 or later. Once you've `installed Python 3 <https://www
Installing from source
**********************

To install mypy from source, clone the github repository and then run pip install locally:
To install mypy from source, clone the github repository and then run
``pip install`` locally:

.. code-block:: text

$ git clone https://github.com/python/mypy.git
$ git clone --recurse-submodules https://github.com/python/mypy.git
$ cd mypy
$ sudo python3 -m pip install --upgrade .