griffe-autodocstringstyle

为外部包设置文档字符串样式为 'auto'。

安装

此项目仅供赞助商通过我的Insiders计划获得。请参阅Insiders 说明 和 安装说明。

用法

[启用(https://mkdocstrings.github.io/griffe/guide/users/extending/#using-extensions)] griffe_autodocstringstyle 扩展。现在从虚拟环境加载的所有包的文档字符串都将使用 auto 风格（自动猜测文档字符串风格）进行解析。

使用 exclude 选项传递不应考虑的包名。如果您必须首先将源安装为包然后加载/记录它们（意味着它们最终也会出现在虚拟环境中），这可能很有用。

使用 MkDocs

plugins:
- mkdocstrings:
    handlers:
      python:
        options:
          extensions:
          - griffe_autodocstringstyle:
              # only useful if your sources can't be found
              # in the current working directory 
              exclude:
              - my_package