Skip to content

Migrate typing documentation to pyproject.toml #2121

@konstin

Description

@konstin

Documentation

The official typing documentation recommends using a setup.py without pyproject.toml (https://typing.python.org/en/latest/guides/libraries.html#companion-type-stub-package, Doc/library/typing.rst). This relies on pre-PEP 621 fallback behavior, while we should teach users to follow PEP 621 and use pyproject.toml. Can we migrate this documentation to use pyproject.toml, including [project] and build-system] as well as [tool.*] for configuration?

The documentation at from packaging.python.org has a tab selection for different build backends, with a default of hatchling instead of setuptools (https://packaging.python.org/en/latest/tutorials/packaging-projects/#choosing-a-build-backend). We found that this is easier to work with than setuptools. A possible alternative would be having the same tabs on typing.python.org (I don't know if that's supported in the renderer), or to move the packaging part of the documentation to packaging.python.org.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    Status

    Todo

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions