python - Sphinx 忽略文件名中以 _ 开头的 py 文件

Question

我在一个测试项目中使用 Sphinx 4.4.0 。我使用sphinx.ext.autodoc和sphinx-apidoc。

但并非所有 py 文件都被识别。它看起来像以文件名开头_的文件被忽略（例如_mypackage.py）。但我不确定那个角色是原因还是其他原因。

您是否知道修改该行为的选项？

这是项目结构

sphinx_versuch
├── docs
│   ├── make.bat
│   ├── Makefile
│   └── source
│       ├── conf.py
│       ├── index.rst
│       ├── modules.rst
│       ├── mypackage.rst
│       ├── _static
│       └── _templates
├── LICENSE
├── README.md
├── src
│   ├── mypackage
│   │   ├── a.py
│   │   ├── b.py
│   │   ├── __init__.py
│   │   └── _mypackage.py
│   ├── setup.cfg
│   └── setup.py
└── tests
    ├── __init__.py
    ├── test_a.py
    ├── test_b.py
    └── test_mypackage.py

Answer 1

选项--private或-P确保sphinx-apidoc还包括私有文件（按照惯例以下划线开头）。

另请参阅 https://www.sphinx-doc.org/en/master/man/sphinx-apidoc.html#cmdoption-sphinx-apidoc-P