Sphinx 找不到我的 python 文件。说“没有名为...的模块”

我有一个关于 Sphinx 自动文档生成的问题。我觉得我想做的事情应该很简单，但由于某种原因，它不起作用。

我有一个Python项目，其目录名为slotting_tool。该目录位于C:\Users\Sam\Desktop\picnic-data-shared-tools\standalone\slotting_tool

我使用设置 Sphinxsphinx-quickstart。那么我的目录结构（简化）如下：

slotting_tool/
|_ build/
|_ source/
|___ conf.py
|___ index.rst
|_ main/
|___ run_me.py

现在，我将项目的根目录设置为slotting_tool通过将以下内容添加到conf.py file.

import os
import sys
sys.path.insert(0, os.path.abspath('..'))

接下来我更新一下我的index.rst文件看起来像这样：

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

.. automodule:: main.run_me
   :members:

当尝试使用以下命令构建我的 html 时sphinx-build -b html source .\build命令，我得到以下输出，其中no module named error:

(base) C:\Users\Sam\Desktop\picnic-data-shared-tools\standalone\slotting_tool>sphinx-build -b html source .\build
Running Sphinx v1.8.1
loading pickled environment... done
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 1 source files that are out of date
updating environment: [] 0 added, 1 changed, 0 removed
reading sources... [100%] index
WARNING: autodoc: failed to import module 'run_me' from module 'main'; the following exception was raised:
No module named 'standalone'
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] index
generating indices... genindex
writing additional pages... search
copying static files... done
copying extra files... done
dumping search index in English (code: en) ... done
dumping object inventory... done
build succeeded, 1 warning.

The HTML pages are in build.

没有 HTML 页面引用run_me.py在构建中。我尝试将根目录设置为所有不同类型的目录，并且尝试替换所有点.带反斜杠\等等，但似乎无法找出我做错了什么。

顺便说一句，声明standalone不是一个模块实际上是这样，它只是一个没有模块的目录__init__.py。不知道这样会不会造成一些麻烦呢？

有人有主意吗？

这是适用于“入门”的通常“规范方法”当您的源代码位于src目录如Project/src而不是简单地呆在里面Project基本目录。

遵循以下步骤：

1. 创建一个docs目录在你的Project目录（来自这个docs目录中执行以下步骤中的命令）。

2. sphinx-quickstart（选择单独的source from build。地点.html and .rst文件在不同的文件夹中）。

3. sphinx-apidoc -o ./source ../src

4. make html

这将产生以下结构（假设你.py源文件驻留在Project/src):

Project
|
├───docs
│   │   make.bat
│   │   Makefile
│   │
│   ├───build
│   └───source
│       │   conf.py
│       │   index.rst
│       │   modules.rst
│       │   stack.rst
│       │
│       ├───_static
│       └───_templates
└───src
        stack.py

In your conf.py您可以添加（在第 2 步之后）：

import os
import sys
sys.path.insert(0, os.path.abspath(os.path.join('..', '..', 'src')))

还包括在conf.py:

extensions = ['sphinx.ext.autodoc', 'sphinx.ext.napoleon']

And in index.rst你会链接modules.rst:

Welcome to Project's documentation!
================================

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

   modules
      
   
Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

Your stack.rst and modules.rst由自动生成sphinx-apidoc，无需更改它们（此时）。但只是为了让你知道它们是这样的：

stack.rst:

stack module
============

.. automodule:: stack
   :members:
   :undoc-members:
   :show-inheritance:

modules.rst:

src
===

.. toctree::
   :maxdepth: 4

   stack

and: