python - 在 Travis CI 中自动构建 Mkdocs 文档

如何在 Travis CI 中自动部署我的 Mkdocs 文档？

最佳答案

以下是如何自动部署您的 mkdocs 文档。只需按照以下 3 个步骤操作即可。
步骤1
只需将以下代码片段插入 .travis.yml 配置文件中的相应位置:

language: python # Set the build language to Python

python: 3.8 # Set the version of Python to use

branches: master # Set the branch to build from

install:
    - pip install mkdocs # Install the required dependencies

script: true # Skip script (Don't use this if one already exists)

before_deploy:
    - mkdocs build --verbose --clean --strict # Build a local version of the docs

deploy: # Deploy documentation to Github in the gh_pages branch
    provider: pages
    skip_cleanup: true
    github_token: $github_token
    local_dir: site
    on:
        branch: master

第2步
如果您使用的 mkdocs 主题不是 mkdocs 或 readthedocs，请按照以下步骤进行安装:

场景 1:主题可通过 pip 安装(例如 mkdocs-material )

将 pip install mkdocs 附加到您需要安装的其他软件包中，例如使用 mkdocs-material 将是 pip install mkdocs mkdocs-material pymdown-extensions pygments

场景 2:主题是 而不是 可通过 pip 安装(例如 docskimmer )

从 --strict 中删除 mkdocs build --verbose --clean --strict 参数以抑制使用无法通过 pip 安装的主题时可能出现的错误。

在before_deploy部分添加设置主题所需的代码，在mkdocs build --verbose --clean上方

before_deploy 部分中的代码对于 docskimmer 如下所示:

  before_deploy:
      - git clone https://github.com/hfagerlund/mkdocs-docskimmer.git # Clone the repo hosting the code
      - cp -r $PWD/mkdocs-docskimmer/mkdocs_docskimmer . # Copy the required code to the repo root
      - cp -r $PWD/mkdocs-docskimmer/mkdocs_docskimmer/. ./docs # Copy the required code to the docs folder
      - mkdocs build --verbose --clean # Build a local version of the docs

第 3 步
最后的 步骤是告诉 Travis CI 登录到您的 GitHub 帐户以推送更改所需的凭据:

如果您已经使用 public_repo 范围设置了个人访问 token ，请跳至步骤 11

转到 this URL。如果加载，请跳到第 7 步。否则，照常继续这些说明。

转到你的 Github 账户的 settings

点击Developer settings

点击Personal access tokens

点击Generate new token

你可能需要输入你的 GitHub 密码来授权创建

在 Token description 下，为您的 token 选择一个名称 - 可以是任何名称；我将其命名为 Travis CI 之类的东西，因为您可以将 token 重用于任意数量的存储库。

启用 public_repo 范围/权限

点击页面底部的Generate token

转到要为