python - 由于缺少 pandoc，构建文档失败

Question

问题

在 readthedocs.io 网络界面上单击“构建”时，我无法成功构建我的文档，但它在我的本地机器上构建得很好。为了测试这是一个环境问题，我创建了一个虚拟环境:

conda create virtualenv -n venv
conda env export -n venv
source activate venv

然后我将我的 requirements.txt 文件安装为:

pip install -r requirements.txt

然后跑了

make clean html

在虚拟环境和在线 buildthedocs 中，我收到错误消息:

Notebook error:
PandocMissing in ex_degassing.ipynb:
Pandoc wasn't found.
Please check that pandoc is installed:
http://pandoc.org/installing.html
make: *** [html] Error 2

我已经搜索并搜索了一个解决方案，但我最好的猜测是 pandoc 没有通过 pip 安装，即使它在 requirements.txt 文件中。我还尝试通过替换 pandoc 来告诉它从源代码构建与 git+git://github.com/jgm/pandoc#egg=pandoc在我的 requirements.txt 文件中，但这不起作用(有关我的文件的外观，请参见下文)。我可以轻松地在本地机器上安装 pandoc，但无法通过我的虚拟环境或 readthedocs 中的 requirements.txt 文件进行安装。

我的一些文件

这是我的 要求.txt 文件:

sphinx>=1.4
sphinx_rtd_theme
ipykernel
nbsphinx
pandas
pandoc
numpy
matplotlib
ipynb
scipy

我通读了所有的 readthedocs documentation并且，讽刺的是，发现构建文档对于我有限的编码能力的人来说严重不足。我尝试制作 readthedocs.yml 和 environment.yaml 文件，但我不知道它们是否在做任何事情，或者它们是否正确编写。为了完整起见，以下是这些文件:

readthedocs.yml

# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2
# Build documentation in the docs/ directory with Sphinx
sphinx:
  configuration: docs/conf.py
python:
  version: 3.7
  install:
    - requirements: docs/requirements.txt

环境.yaml

channels:
  - conda-forge
dependencies:
  - python =3.7
  - pandoc

总之

我已经用 readthedocs 和 sphinx 创建了漂亮的文档，但我无法在网络上构建它。我怎样才能:a)解决安装 pandoc 的问题(是这个问题吗？？)或 b)消除对 pandoc 的需要(例如，有没有办法在我的文档中包含 jupyter notebook 文件而不需要 pandoc？如何做这个？)？

非常感谢任何人的建议!

Answer 1

好吧，我让它在我的系统上运行:

从 https://pandoc.org/installing.html 下载并安装 pandoc

开始一个新的 session (cmd 或 power shell)

再次调用 sphinx make

就那么简单。希望你能得到它的工作!