github - 使用 Travis 在 gh-pages 上使用 Rustdoc

Question

我已生成文档 for my project与 cargo doc，它是在 target/doc 目录中制作的。我想让用户在没有本地副本的情况下查看此文档，但我不知道如何将此文档推送到存储库的 gh-pages 分支。 Travis CI 会帮助我自动执行此操作，但我也无法让它工作。我关注了this guide ，并设置一个 .travis.yml 文件和一个 deploy.sh 脚本。根据构建日志，一切正常，但 gh-pages 分支永远不会更新。我的操作系统是 Windows 7。

Answer 1

最好用travis-cargo ，旨在简化文档部署，并且还具有其他功能。它的自述文件提供了一个 .travis.yml 文件的示例，尽管以最简单的形式它可能看起来像这样:

language: rust
sudo: false

rust:
  - nightly
  - beta
  - stable

before_script:
  - pip install 'travis-cargo<0.2' --user && export PATH=$HOME/.local/bin:$PATH

script:
  - |
      travis-cargo build &&
      travis-cargo test &&
      travis-cargo --only beta doc

after_success:
  - travis-cargo --only beta doc-upload

# needed to forbid travis-cargo to pass `--feature nightly` when building with nightly compiler
env:
  global:
    - TRAVIS_CARGO_NIGHTLY_FEATURE=""

它具有很强的 self 描述性，因此很明显，例如，如果您想使用另一个 Rust 发布序列来构建文档，该怎么做。

为了使上面的 .travis.yml 工作，您需要以某种方式设置您的 GH_TOKEN。基本上有两种方法可以做到这一点:在 .travis.yml 中通过加密字符串，或者在 Travis 本身的项目选项中配置它。我更喜欢后一种方式，所以我不需要安装 travis 命令行工具或污染我的 .travis.yml (所以上面的配置文件不包含 secure选项)，但您也可以选择其他方式。