sphinx 项目的 gitlab-page 未按预期工作

Question

整个项目的链接https://gitlab.com/ComplicatedPhenomenon/doubancrawler

我在本地机器上测试了生成的文档，它工作正常

gitlab 页面如下 (https://complicatedphenomenon.gitlab.io/doubancrawler/api.html)

.gitlab-ci.yml 有什么问题吗？

image: python:3.7-alpine

test:
  stage: test
  script:
  - pip install -r requirements2.txt
  - cd docs/source/
  - sphinx-build -b html . public
  - mv public ../..
  only:
  - branches
  except:
  - master

pages:
  stage: deploy
  script:
  - pip install -r requirements2.txt
  - cd docs/source/
  - sphinx-build -b html . public
  - mv public ../..
  artifacts:
    paths:
    - public
  only:
  - master

Answer 1

当 autodoc 无法找到/导入您的参考文献时会发生这种情况。

您没有安装项目的所有要求。为了使 autodoc 工作，您需要能够导入所有包模块。但是，您只是安装了构建文档的要求 (requirements2.txt)。

否则，autodoc 将在尝试提取您的文档字符串时收到 ImportError，因为您的模块会尝试导入未安装的包。

在本地，您可能没有问题，因为您已经安装了所有要求。

要解决此问题，请将pip install -r requirements.txt 添加到您的工作中。