Sphinx忽略以_in文件名开头的py文件

原学程将引见Sphinx疏忽以_in文件名开首的py文件的处置办法，这篇学程是从其余处所瞅到的，而后减了1些海外法式员的疑问与解问，愿望能对于您有所赞助，佳了，上面开端进修吧。

成绩描写

我正在应用test project中的Sphinx 四.四.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

推举谜底

--private或者-P选项sphinx-apidoc保证也包含公用文件(按通例以下划线开首)。

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

佳了闭于Sphinx疏忽以_in文件名开首的py文件的学程便到这里便停止了，愿望趣模板源码网找到的这篇技巧文章能赞助到年夜野，更多技巧学程不妨在站内搜刮。