Skip to content

Reorganize mypy documentation into sections #5104

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
May 24, 2018

Conversation

Michael0x2a
Copy link
Collaborator

This pull request reorganizes the documentation into different sections. This change should hopefully:

  1. Make it a little easier for new users to navigate the docs.
  2. Make the nav sidebar feel a little less overwhelming.
  3. Make it more obvious which parts of the documentation are about type
    hint semantics vs which are about specifically mypy.

This pull request also retitled the cheat sheets: the phrase "mypy syntax" didn't feel quite accurate to me.

This commit reorganizes the documentation into different sections. This
change should hopefully:

1.  Make it a little easier for new users to navigate the docs.
2.  Make the nav sidebar feel a little less overwhelming.
3.  Make it more obvious which parts of the documentation are about type
    hint semantics vs which are about specifically mypy.

This commit also retitled the cheat sheets: the phrase "mypy syntax"
didn't feel quite accurate to me.
@Michael0x2a Michael0x2a force-pushed the add-sections-to-docs branch from 2b0955c to 93b3932 Compare May 24, 2018 02:28
@Michael0x2a
Copy link
Collaborator Author

Also, I uploaded a (temporary) build of this branch to Read the Docs if anybody wants to quickly see what it looks like. The only real changes are to the index page and the nav.

Copy link
Collaborator

@msullivan msullivan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great! The sections make it much less wall of text.

@gvanrossum gvanrossum merged commit 464b553 into python:master May 24, 2018
@gvanrossum
Copy link
Member

Thanks! This reminds me -- we need a section on Python 3.7 features.

@Michael0x2a Michael0x2a deleted the add-sections-to-docs branch July 9, 2018 04:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants