Skip to content
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

Reorganize mypy documentation into sections #5104

Merged
merged 1 commit into from May 24, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/source/cheat_sheet.rst
@@ -1,7 +1,7 @@
.. _cheat-sheet-py2:

Mypy syntax cheat sheet (Python 2)
==================================
Type hints cheat sheet (Python 2)
=================================

This document is a quick cheat sheet showing how the `PEP 484 <https://www.python.org/dev/peps/pep-0484/>`_ type
language represents various common types in Python 2.
Expand Down
4 changes: 2 additions & 2 deletions docs/source/cheat_sheet_py3.rst
@@ -1,7 +1,7 @@
.. _cheat-sheet-py3:

Mypy syntax cheat sheet (Python 3)
==================================
Type hints cheat sheet (Python 3)
=================================

This document is a quick cheat sheet showing how the `PEP 484 <https://www.python.org/dev/peps/pep-0484/>`_ type
language represents various common types in Python 3. Unless otherwise noted, the syntax is valid on all versions of Python 3.
Expand Down
34 changes: 28 additions & 6 deletions docs/source/index.rst
Expand Up @@ -10,31 +10,53 @@ Mypy is a static type checker for Python 3 and Python 2.7.

.. toctree::
:maxdepth: 2
:caption: First steps

introduction
basics
getting_started
builtin_types

.. toctree::
:maxdepth: 2
:caption: Cheat sheets

cheat_sheet_py3
cheat_sheet

.. toctree::
:maxdepth: 2
:caption: Type system reference

python2
builtin_types
type_inference_and_annotations
kinds_of_types
class_basics
dynamic_typing
function_overloading
casts
duck_type_compatibility
common_issues
generics
supported_python_features
additional_features

.. toctree::
:maxdepth: 2
:caption: Configuring and running mypy

command_line
config_file
mypy_daemon
supported_python_features
python36
additional_features


.. toctree::
:maxdepth: 2
:caption: Miscellaneous

installed_packages
common_issues
faq
cheat_sheet
cheat_sheet_py3
revision_history

Indices and tables
Expand Down