-
Notifications
You must be signed in to change notification settings - Fork 0
49 lines (40 loc) · 1.41 KB
/
docs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
name: Docs CI
on:
push:
branches:
# Add more branches here to publish docs from other branches
- master
- main
tags:
- "*"
pull_request:
jobs:
docs:
runs-on: ubuntu-latest
steps:
- name: Avoid git conflicts when tag and branch pushed at same time
if: startsWith(github.ref, 'refs/tags')
run: sleep 60
- name: Install Packages
# Can delete this if you don't use graphviz in your docs
run: sudo apt-get install graphviz
- name: Build docs
uses: dls-controls/pipenv-run-action@v1
with:
pipenv-run: docs
- name: Check links resolve
run: pipenv run docs -b linkcheck
- name: Move to versioned directory
# e.g. master or 0.1.2
run: mv build/html ".github/pages/${GITHUB_REF##*/}"
- name: Write versions.txt
run: pipenv run sphinx_rtd_theme_github_versions .github/pages
- name: Publish Docs to gh-pages
if: github.event_name == 'push'
# We pin to the SHA, not the tag, for security reasons.
# https://docs.github.com/en/actions/learn-github-actions/security-hardening-for-github-actions#using-third-party-actions
uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e # v4.0.0
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: .github/pages
keep_files: true