背景
我的代码具有以下结构:
.
âââ my_package
âââ __init__.py
âââ classif
â  âââ __init__.py
â  âââ inference.py
â  âââ models.py
âââ datasets
â  âââ __init__.py
â  âââ datasets.py
âââ matching
âââ __init__.py
âââ elastic.py
âââ search.py
A之后
sphinx-quickstart
用
autodoc
)我跑了
sphinx-apidoc
如下:
sphinx-apidoc -f -o source my_package -e -M
我现在有以下文件:
.
âââ Makefile
âââ build
âââ my_package
â  âââ __init__.py
â  âââ __pycache__
â  âââ classif
â  âââ datasets
â  âââ matching
âââ source
âââ _static
âââ _templates
âââ conf.py
âââ index.rst
âââ modules.rst
âââ my_package.classif.inference.rst
âââ my_package.classif.models.rst
âââ my_package.classif.rst
âââ my_package.datasets.datasets.rst
âââ my_package.datasets.rst
âââ my_package.matching.elastic.rst
âââ my_package.matching.rst
âââ my_package.matching.search.rst
âââ my_package.rst
我也修改了
conf.py
要添加:
import os
import sys
sys.path.insert(0, os.path.abspath('.'))
sys.path.insert(0, os.path.abspath('..'))
并添加了
modules
到
index.rst
:
.. toctree::
:maxdepth: 2
:caption: Contents:
modules
# [more lines]
现在是问题所在
运行后
make clean ; make html
我收到警告:
/path/to/my_package.classif.rst: WARNING: document isn't included in any toctree
/path/to/my_package.datasets.rst: WARNING: document isn't included in any toctree
/path/to/my_package.matching.rst: WARNING: document isn't included in any toctree
这是有道理的
Sphinx Apidoc没有在
my_package.rst
. 我怎么解决这个问题?