Skip to content
master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
mypy/docs/
Go to file
mypy/docs/

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
. .
source
 
 
Makefile
 
 
README.md
 
 
make.bat
 
 
requirements-docs.txt
 
 
Mypy Documentation What's this? Building the documentation Helpful documentation build commands Documentation on Read The Docs

README.md

Mypy Documentation

What's this?

This directory contains the source code for Mypy documentation (under source/) and build scripts. The documentation uses Sphinx and reStructuredText. We use furo as the documentation theme.

Building the documentation

Install Sphinx and other dependencies (i.e. theme) needed for the documentation. From the docs directory, use pip:

$ pip install -r requirements-docs.txt

Build the documentation like this:

$ make html

The built documentation will be placed in the docs/build directory. Open docs/build/index.html to view the documentation.

Helpful documentation build commands

Clean the documentation build:

$ make clean

Test and check the links found in the documentation:

$ make linkcheck

Documentation on Read The Docs

The mypy documentation is hosted on Read The Docs, and the latest version can be found at https://mypy.readthedocs.io/en/latest.