Skip to content

tiangolo/griffe-typingdoc

 
 

Repository files navigation

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

About

Griffe extension for PEP 727 – Documentation Metadata in Typing.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 93.1%
  • Makefile 4.4%
  • Shell 1.9%
  • Dockerfile 0.6%