sphinxcontrib-autofile

从glob表达式生成多个文件的模块的sphinx扩展。

使用方法

以MyST为例。rst类似。

docs/conf.py:

# ...
extensions = [
    "myst_parser",
    "sphinxcontrib.autofile",
]
# ...

docs/index.md:

```{autofile} ../src/sphinxcontrib/autofile/*.py
:members:
```

它将被翻译成

```{eval-rst}
.. automodule:: sphinxcontrib.autofile
    :members:

.. automodule:: sphinxcontrib.autofile.directive
    :members:

... (more modules)
```

当你的模块很多时，它会节省你的时间。

自定义

```{autofile} ../src/sphinxcontrib/autofile/*.py
:prefix: your_prefix
:template: /the/path/of/your/template
```

• prefix：如果你不使用src-layout，请更改它。
• template：模板使用jinja语法。请参阅示例。

替代方案

• sphinxcontrib-eval

请参阅 了解更多信息。