Skip to content

Commit 6ede8b1

Browse files
committed
ci: fix CI job to deploy docs, and make it run on pull requests too
1 parent df81b15 commit 6ede8b1

File tree

1 file changed

+18
-3
lines changed

1 file changed

+18
-3
lines changed

.github/workflows/docs.yml

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,36 @@
11
name: Publish docs via GitHub Pages
2+
23
on:
34
push:
45
branches:
56
- develop
7+
pull_request:
8+
branches:
9+
- develop
10+
611
jobs:
712
build:
813
name: Deploy docs
914
if: "github.repository == 'OpenMathLib/OpenBLAS'"
1015
runs-on: ubuntu-latest
1116
steps:
1217
- uses: actions/checkout@v4
18+
with:
19+
fetch-depth: 0
20+
1321
- uses: actions/setup-python@v5
1422
with:
1523
python-version: "3.10"
16-
- run: pip install mkdocs mkdocs-material
17-
# mkdocs gh-deploy command only builds to the top-level, hence building then deploying ourselves
18-
- run: mkdocs build
24+
25+
- name: Install MkDocs and doc theme packages
26+
run: pip install mkdocs mkdocs-material mkdocs-git-revision-date-localized-plugin
27+
28+
- name: Build docs site
29+
run: mkdocs build
30+
31+
# mkdocs gh-deploy command only builds to the top-level, hence deploying
32+
# with this action instead.
33+
# Deploys to http://www.openmathlib.org/OpenBLAS/docs/
1934
- name: Deploy docs
2035
uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e # v4.0.0
2136
if: ${{ github.ref == 'refs/heads/develop' }}

0 commit comments

Comments
 (0)