Skip to main content

Griffe extension for PEP 727 – Documentation Metadata in Typing.

Project description

Griffe TypingDoc

ci documentation pypi version gitter

Griffe extension for annotated-doc (originally PEP 727):

Document parameters, class attributes, return types, and variables inline, with Annotated.

Installation

pip install griffe-typingdoc

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

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

Sponsors

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.3.1.tar.gz (31.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

griffe_typingdoc-0.3.1-py3-none-any.whl (10.1 kB view details)

Uploaded Python 3

File details

Details for the file griffe_typingdoc-0.3.1.tar.gz.

File metadata

  • Download URL: griffe_typingdoc-0.3.1.tar.gz
  • Upload date:
  • Size: 31.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.2

File hashes

Hashes for griffe_typingdoc-0.3.1.tar.gz
Algorithm Hash digest
SHA256 2ff4703115cb7f8a65b9fdcdd1f3c3a15f813b6554621b52eaad094c4782ce96
MD5 13af6e489b810f6ce73a11a782f4b4c9
BLAKE2b-256 ce2628182e0c8055842bf3da774dee1d5b789c0f236c078dcbdca1937b5214dc

See more details on using hashes here.

File details

Details for the file griffe_typingdoc-0.3.1-py3-none-any.whl.

File metadata

File hashes

Hashes for griffe_typingdoc-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ecbd457ef6883126b8b6023abf12e08c58e1c152238a2f0e2afdd67a64b07021
MD5 4e0ef196612a29b4e453f96a1dc7751c
BLAKE2b-256 b6c4cf543fbde49e1ae44830ef0840a4d6ee9f4e4f338138a7766d4e37cf6440

See more details on using hashes here.

Supported by

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