Skip to content

Commit 729d04c

Browse files
authored
try to fix doc deployment (#92)
Fixes #91 - Switches doc deployment to use peaceiris/actions-gh-pages action
1 parent 160ddca commit 729d04c

2 files changed

Lines changed: 8 additions & 30 deletions

File tree

.github/workflows/docs.yaml

Lines changed: 6 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -51,31 +51,9 @@ jobs:
5151
python setup.py build_sphinx
5252
5353
- name: deploy docs
54-
env:
55-
GIT_CI_USER: github-actions
56-
GIT_CI_EMAIL: "github-action@users.noreply.github.com"
57-
MDA_DOCDIR: build/sphinx/html
58-
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
59-
GH_REPOSITORY: github.com/MDAnalysis/GridDataFormats.git
60-
GH_DOC_BRANCH: master
61-
62-
run: |
63-
cd ${MDA_DOCDIR}
64-
65-
rev=$(git rev-parse --short HEAD)
66-
67-
# set up git
68-
git init
69-
git config user.name ${GIT_CI_USER}
70-
git config user.email ${GIT_CI_EMAIL}
71-
git remote add upstream "https://${GH_TOKEN}@${GH_REPOSITORY}"
72-
git fetch --depth 50 upstream ${GH_DOC_BRANCH} gh-pages
73-
git reset upstream/gh-pages
74-
75-
touch .
76-
touch .nojekyll
77-
78-
# comit and push
79-
git add -A .
80-
git commit -m "rebuilt html docs from branch ${GH_DOC_BRANCH} with sphinx at ${rev}"
81-
git push -q upstream HEAD:gh-pages
54+
uses: peaceiris/actions-gh-pages@v3
55+
with:
56+
github_token: ${{ secrets.GITHUB_TOKEN }}
57+
publish_dir: ./build/sphinx/html
58+
user_name: 'github-actions'
59+
user_email: 'github-action@users.noreply.github.com'

doc/source/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,8 @@
6161
# General information about the project.
6262
project = u'GridDataFormats'
6363
authors = (u'Oliver Beckstein, Jan Domanski, Jesse Johnson, Max Linke, Tyler Luchko, '
64-
u'Dominik Mierzejewski, Giacomo Fiorin, Lily Wang')
65-
copyright = u'2007-2020, ' + authors
64+
u'Dominik Mierzejewski, Giacomo Fiorin, Lily Wang, Josh Vermaas, Irfan Alibay')
65+
copyright = u'2007-2021, ' + authors
6666

6767
# The version info for the project you're documenting, acts as replacement for
6868
# |version| and |release|, also used in various other places throughout the

0 commit comments

Comments
 (0)