Python Sphinx api文档未将包放在一起 背景

Python Sphinx api文档未将包放在一起 背景,python,python-sphinx,sphinx-apidoc,Python,Python Sphinx,Sphinx Apidoc,我的代码具有以下结构: . └── my_package ├── __init__.py ├── classif │   ├── __init__.py │   ├── inference.py │   └── models.py ├── datasets │   ├── __init__.py │   └── datasets.py └── matching ├── __init__.py

我的代码具有以下结构:

.
└── my_package
    ├── __init__.py
    ├── classif
    │   ├── __init__.py
    │   ├── inference.py
    │   └── models.py
    ├── datasets
    │   ├── __init__.py
    │   └── datasets.py
    └── matching
        ├── __init__.py
        ├── elastic.py
        └── search.py
sphinx快速启动之后(使用
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('..'))
并将
模块
添加到
索引.rst

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   modules

# [more lines]
现在问题来了 运行
后进行清洗;生成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

这是有道理的,因为斯芬克斯apidoc没有在
my_package.rst
中引用它们。我该如何解决这个问题?

这个问题实际上是已知的->

升级到sphinx
1.7.6
解决了这个问题