1Python Typing Documentation
2~~~~~~~~~~~~~~~~~~~~~~~~~~~
3
4Reading the docs
5=================
6
7The live documentation for Python's static typing can be found at
8`typing.readthedocs.io <https://typing.readthedocs.io/>`_.
9
10Building the docs
11=================
12
13The documentation is built with tools which are not included in this
14tree but are maintained separately and are available from
15`PyPI <https://pypi.org/>`_.
16
17* `Sphinx <https://pypi.org/project/Sphinx/>`_
18* `python-docs-theme <https://pypi.org/project/python-docs-theme/>`_
19
20The easiest way to install these tools is to create a virtual environment and
21install the tools into there.
22
23Using make
24----------
25
26To get started on UNIX, you can create a virtual environment with the command ::
27
28  make venv
29
30That will install all the tools necessary to build the documentation. Assuming
31the virtual environment was created in the ``venv`` directory (the default;
32configurable with the VENVDIR variable), you can run the following command to
33build the HTML output files::
34
35  make html
36
37By default, if the virtual environment is not created, the Makefile will
38look for instances of sphinxbuild and blurb installed on your process PATH
39(configurable with the SPHINXBUILD and BLURB variables).
40
41Available make targets are:
42
43* "clean", which removes all build files.
44
45* "venv", which creates a virtual environment with all necessary tools
46  installed.
47
48* "html", which builds standalone HTML files for offline viewing.
49
50* "text", which builds a plain text file for each source file.
51