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

Question

我正在 test project 中玩弄 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

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

Sphinx ignores py-file starting with a _ in filename

python

python-sphinx

sphinx-apidoc