名称空间打包了几个级别，包括deep和sphinx

Question

我试图在“com.company”这样的名称空间中使用“project-a”这样的包，并使用隐式名称空间

我发现sphinx apidoc没有将我的包放入文档中的toc，我怀疑是因为com和company名称空间中都没有任何内容

sphinx apidoc正在使用--implicit-namespaces运行，这是在基本项目中PyScapold提供给我的标准配置

我在sphinx构建输出中获得以下内容：

checking consistency... /Users/nward/Code/scratch/namespaces/project-a/docs/api/com.company.rst: WARNING: document isn't included in any toctree

在我开始研究斯芬克斯密码之前，有什么想法吗

我已经在这里发布了代码-现在真的什么都没有：https://github.com/nward/com_company_project-a

Answer 1

我在尝试将python包转换为本机名称空间时遇到了同样的问题。

我一直在运行测试，试图根据文档https://packaging.python.org/namespace_packages使用来自https://github.com/pypa/sample-namespace-packages的本机文件夹解决这个问题，但是使用了一个额外的级别，比如：

setup.py
docs/
example_pkg/
    # No __init__.py here.
    middle_package/
        # No __init__.py here.
        subpackage_a/
            # Sub-packages have __init__.py.
            __init__.py
            module.py

生成文档的命令如下：

sphinx-apidoc  implicit-namespaces  force -o docs/ ./example_pkg/

然后

make -C docs html

问题似乎在于示例_pkg.rst不包含任何指向子页面的链接，该子页面应为：

example\_pkg namespace
======================

.. py:module:: example_pkg

而不是：

example\_pkg namespace
======================

.. py:module:: example_pkg

Subpackages
     -

.. toctree::
   :maxdepth: 4

    example_pkg.subpackage_a

当使用pkgutil-style namespace packages时，所有的东西都可以作为一种魅力使用吗