python - 在不工作的 Python 脚本上执行 sphinx

Question

我正在尝试学习 Docker。

我有一个使用 mod 库的 Python 脚本，该库未安装在我的系统上。目标是在 Docker 容器内执行它。我写了 Dockerfile。我在其中添加了这一行:

RUN pip install --trusted-host pypi.python.org -r requirements.txt

在requirements.txt中我写了mod。

它工作正常，在容器内安装了 mod 并且代码运行良好。

现在，我想在同一脚本上生成 Sphinx 文档。我知道 Sphinx 是如何工作的(基础知识)。我用 sys.path.insert(0, os.path.abspath('..')) 修改了conf.py，它指向包含脚本的目录。 py(以及 Dockerfile 和requirements.txt)，然后我在index.rst中添加了以下内容:Script.py位于名为DockerPython的文件夹内:

.. automodule:: DockerPython.Script
   :members:

当我启动 make html (与其他示例配合良好)时，我得到以下信息:

Running Sphinx v2.0.1
making output directory... 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: 1 added, 0 changed, 0 removed
reading sources... [100%] index
WARNING: autodoc: failed to import module 'Script' from module 'DockerPython'; the following exception was raised:
No module named 'mod'
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.

我得到的页面是空的。

所以，我的问题是:Sphinx 能否在本地 Python 上无法编译和运行良好的脚本上执行(因为本地未安装库)？

如何让它在通过 Docker 使用特定设置运行的脚本上运行？谢谢。

Answer 1

经过两个小时的冲浪，我刚刚弄清楚了。

我只需将此行添加到 conf.py 中:

autodoc_mock_imports = ['mod']