Skip to content

mkdocstrings/griffe-public-wildcard-imports

Repository files navigation

griffe-public-wildcard-imports

documentation gitpod gitter

Mark wildcard imported objects as public.

Installation

This project is available to sponsors only, through my Insiders program. See Insiders explanation and installation instructions.

Usage

Enable the griffe_public_wildcard_imports extension. Now all objects imported through wildcard imports will be considered public, as per the convention.

# All imported objects are marked as public.
from somewhere import *

With MkDocs:

plugins:
- mkdocstrings:
    handlers:
      python:
        options:
          extensions:
          - griffe_public_wildcard_imports