GitLab Pages,用sphinx生成的文档

时间:2018-01-12 09:21:18

标签: gitlab python-sphinx gitlab-ci

我想在GitLab Pages上托管使用Sphinx生成的静态页面。内置index.html文件位于:

project/docs/build/html

.gitlab-ci.yml部署页面的方式如何?我有类似的东西,它不起作用:

pages:
  stage: deploy
  script:
  - echo 'Nothing to do...'
 artifacts:
 paths:
 - docs/build/html
 only:
 - master

1 个答案:

答案 0 :(得分:4)

根据documentation for .gitlab-ci.ymlpages作业有必须遵循的特殊规则:

  
      
  1. 任何静态内容必须放在public/目录
  2. 下   必须定义
  3. artifacts并指定public/目录的路径
  4.   

所以你给出的例子.gitlab-ci.yml看起来像这样:

pages:
  stage: deploy
  script:
    - mv docs/build/html/ public/
  artifacts:
    paths:
    - public
  only:
  - master

当然,如果您因任何原因不想移动html文件夹,可以改为复制它。

为了进一步参考,an example sphinx project for GitLab Pages在您最初发布此问题时被推迟了。