API 参考在本地构建，但不在 RTD 上

Question

我正在尝试使用 autosummary 为 Python 包

GemGIS

构建 API 参考（参见此处）。

API 参考是在本地构建的，没有任何问题，但我收到

ImportError

和

ModuleNotFoundError

说缺少各种 GemGIS 模块。 这里是 RTD 最新版本的链接。

[autosummary] generating autosummary for: getting_started/about.rst, getting_started/api.rst, getting_started/authors.rst, getting_started/contributing.rst, getting_started/data_types.ipynb, getting_started/example/example01.ipynb, getting_started/example/example02.ipynb, getting_started/example/example03.ipynb, getting_started/example/example04.ipynb, getting_started/example/example05.ipynb, ..., getting_started/tutorial/66_generating_voronoi_polygons.ipynb, getting_started/tutorial/67_rotating_gempy_input_data.ipynb, getting_started/tutorial/index.rst, getting_started/whatiswhat/index.rst, getting_started/whatiswhat/interpolations.rst, getting_started/whatiswhat/mesh.rst, getting_started/whatiswhat/projections.rst, getting_started/whatiswhat/raster.rst, getting_started/whatiswhat/vector.rst, index.rst
WARNING: [autosummary] failed to import gemgis.raster.calculate_aspect.
Possible hints:
* KeyError: 'gemgis'
* ModuleNotFoundError: No module named 'gemgis.vector'; 'gemgis' is not a package
* ImportError: no module named gemgis.raster

带有相应目录链接的

conf.py

位于 here，并且应该在本地构建 API 参考时发挥作用。

我在本地构建和 RTD 上使用不同的环境。 RTD 的包可以在here 找到，并且现在应该包含 GemGIS 所需的所有包（有几个可选的依赖项）。我注意到安装可选依赖项时 RTD 上的错误消息发生了变化。但是，此时错误消息对我来说不再有帮助，而且我不知道可能缺少哪些其他包。

使用

autodoc_mock_imports = ["gemgis"]

排除 GemGIS 会在 RTD 上构建自动摘要，但不会为不同方法构建不同的 HTML 页面。

到目前为止我尝试过的：

• 检查 API 参考是否在本地构建，然后将其推送到 GitHub。
• 向

  environment_dev.yml

  添加了可选依赖项，以缓解

  ImportError

  和

  ModuleNotFoundError

  。
• 添加了

  conf.py

  文件的路径，以便 RTD 找到模块
• 从文档中排除 gemgis

Answer 1

我认为您需要在

install

配置中的

python

键下添加一个

.readthedocs.yaml

子键，如下所示： https://www.zonca.dev/posts/2020-05-27-readthedocs-conda.html

因此从 .readthedocs.yaml 的第 20 行开始，它应该为

python:
   version: 3.8
   install:
      - method: pip
        path: .

这样 RTD 实际上会

pip install gemgis

进入您的 conda 环境，并修复这些

ImportError

。

请参阅此处 readthedocs 文档中

install

子键的说明，了解更多信息：https://docs.readthedocs.io/en/stable/config-file/index.html#adjust-python-configuration