Skip to main content

Griffe extension for PEP 727 – Documentation Metadata in Typing.

Project description

Griffe TypingDoc

ci documentation pypi version gitpod gitter

Griffe extension for PEP 727 – Documentation Metadata in Typing.

Installation

With pip:

pip install griffe-typingdoc

With pipx:

python3.8 -m pip install --user pipx
pipx install griffe-typingdoc

To use the extension in a MkDocs project, use this configuration:

# mkdocs.yml
plugins:
- mkdocstrings:
    handlers:
      python:
        options:
          extensions:
          - griffe_typingdoc

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

griffe_typingdoc-0.2.4.tar.gz (282.8 kB view hashes)

Uploaded Source

Built Distribution

griffe_typingdoc-0.2.4-py3-none-any.whl (340.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page