Skip to content

Commit 3152a46

Browse files
committed
CI: Start building docs on GH actions (#775)
* CI: Start building docs on GH actions * TEST: Test publication to a gh-pages-test branch * DOC: Push to gh-pages on tag * CI: Drop CircleCI
1 parent c1cc9f0 commit 3152a46

File tree

3 files changed

+58
-76
lines changed

3 files changed

+58
-76
lines changed

.circleci/artifact_path

Lines changed: 0 additions & 1 deletion
This file was deleted.

.circleci/config.yml

Lines changed: 0 additions & 75 deletions
This file was deleted.

.github/workflows/docs.yml

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
name: Documentation
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
- maint/*
8+
- rel/*
9+
- docs/*
10+
tags:
11+
- '*'
12+
13+
defaults:
14+
run:
15+
shell: bash
16+
17+
jobs:
18+
docs:
19+
runs-on: ubuntu-latest
20+
strategy:
21+
matrix:
22+
include:
23+
- python-version: 3.9
24+
steps:
25+
- uses: actions/checkout@v2
26+
with:
27+
submodules: recursive
28+
fetch-depth: 0
29+
- name: Set up Python ${{ matrix.python-version }}
30+
uses: actions/setup-python@v2
31+
with:
32+
python-version: ${{ matrix.python-version }}
33+
- name: Display Python version
34+
run: python -c "import sys; print(sys.version)"
35+
- name: Create virtual environment
36+
run: tools/ci/create_venv.sh
37+
- name: Install pybids
38+
run: tools/ci/install_extras.sh
39+
env:
40+
EXTRA_PIP_FLAGS: ""
41+
CHECK_TYPE: doc
42+
- name: Build documentation
43+
run: |
44+
source tools/ci/activate.sh
45+
make -C doc html
46+
- name: Upload docs as artifacts
47+
uses: actions/upload-artifact@v2
48+
with:
49+
path: doc/_build/html
50+
- name: Deploy (on tags)
51+
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
52+
uses: peaceiris/actions-gh-pages@v3
53+
with:
54+
github_token: ${{ secrets.GITHUB_TOKEN }}
55+
publish_dir: doc/_build/html
56+
force_orphan: true
57+
user_name: "BIDS Maintenance"
58+
user_email: [email protected]

0 commit comments

Comments
 (0)