Griffe Inherited Docstrings

Griffe扩展，用于继承文档字符串。

安装

使用 pip

pip install griffe-inherited-docstrings

使用 pipx

python3.8 -m pip install --user pipx
pipx install griffe-inherited-docstrings

用法

使用Python

import griffe

griffe.load("...", extensions=griffe.load_extensions(["griffe_inherited_docstrings"]))

使用MkDocs和mkdocstrings

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

该扩展将对每个类及其成员进行迭代，当文档字符串尚未定义时，将从父类设置文档字符串。