From 5aa514e8d907312d6838a3b501de5050a4684e72 Mon Sep 17 00:00:00 2001 From: Chris Kleinknecht Date: Tue, 24 Sep 2019 15:00:41 -0700 Subject: [PATCH 1/7] Test GH actions to build docs --- .github/workflows/docs.yml | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 .github/workflows/docs.yml diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 00000000000..ca9a556f2f7 --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,36 @@ +name: Docs + +on: + pull_request: # change to 'push' + branches: + - master + +jobs: + docs: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v1 + - uses: actions/setup-python@v1 + - name: Build docs + run: | + pip install tox + tox -e docs + - name: Publish to gh-pages + run: | + pwd + cp -R docs/_build/html/* docs/ + rm -rf docs/build/ + ls -lah docs/ + git add -f docs/ + echo 'GITHUB_EVENT_PATH' + echo $GITHUB_EVENT_PATH + cat $GITHUB_EVENT_PATH + echo 'GITHUB_ACTOR' + echo $GITHUB_ACTOR + echo 'GITHUB_EVENT_NAME' + git config --global user.email "libc@google.com" + git config --global user.name "Chris Kleinknecht" + git commit -m "Publish to GH pages" + echo "nop" + echo "git@github.com:${GITHUB_REPOSITORY}.git" + git push -f "git@github.com:${GITHUB_REPOSITORY}.git" HEAD:gh-pages From c8d4d97cd418f5d3a2eacafbefb8f95a754a6011 Mon Sep 17 00:00:00 2001 From: Chris Kleinknecht Date: Tue, 24 Sep 2019 16:21:58 -0700 Subject: [PATCH 2/7] Use JamesIves/github-pages-deploy-action --- .github/workflows/docs.yml | 23 +++++------------------ 1 file changed, 5 insertions(+), 18 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index ca9a556f2f7..72f452c3a98 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -16,21 +16,8 @@ jobs: pip install tox tox -e docs - name: Publish to gh-pages - run: | - pwd - cp -R docs/_build/html/* docs/ - rm -rf docs/build/ - ls -lah docs/ - git add -f docs/ - echo 'GITHUB_EVENT_PATH' - echo $GITHUB_EVENT_PATH - cat $GITHUB_EVENT_PATH - echo 'GITHUB_ACTOR' - echo $GITHUB_ACTOR - echo 'GITHUB_EVENT_NAME' - git config --global user.email "libc@google.com" - git config --global user.name "Chris Kleinknecht" - git commit -m "Publish to GH pages" - echo "nop" - echo "git@github.com:${GITHUB_REPOSITORY}.git" - git push -f "git@github.com:${GITHUB_REPOSITORY}.git" HEAD:gh-pages + uses: JamesIves/github-pages-deploy-action@2.0.2 + env: + ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }} + BRANCH: gh-pages + FOLDER: docs/_build/html/ From 8abcfa695825626e2f48c69e635e1d1f5bee7df4 Mon Sep 17 00:00:00 2001 From: Chris Kleinknecht Date: Tue, 24 Sep 2019 16:38:15 -0700 Subject: [PATCH 3/7] Use personal access token Because of https://github.com/JamesIves/github-pages-deploy-action/issues/5 --- .github/workflows/docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 72f452c3a98..5ed2768fc90 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -18,6 +18,6 @@ jobs: - name: Publish to gh-pages uses: JamesIves/github-pages-deploy-action@2.0.2 env: - ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }} + ACCESS_TOKEN: ${{ secrets.DocsPushToken }} BRANCH: gh-pages FOLDER: docs/_build/html/ From 640e36feb0f6b82b9979b4556cfaf97f5403d486 Mon Sep 17 00:00:00 2001 From: Chris Kleinknecht Date: Tue, 24 Sep 2019 17:00:53 -0700 Subject: [PATCH 4/7] Stop jekyll --- tox.ini | 3 +++ 1 file changed, 3 insertions(+) diff --git a/tox.ini b/tox.ini index d0fb6cc2dc4..b466fc38a7b 100644 --- a/tox.ini +++ b/tox.ini @@ -96,3 +96,6 @@ changedir = docs commands = sphinx-build -W --keep-going -b html -T . _build/html + ; stop jekyll from running on gh-pages + ; https://help.github.com/en/articles/files-that-start-with-an-underscore-are-missing + touch _build/html/.nojekyll From 39adaf2a3a75ac1e4543bc8c59e096f8a58a1fb7 Mon Sep 17 00:00:00 2001 From: Chris Kleinknecht Date: Tue, 24 Sep 2019 17:06:48 -0700 Subject: [PATCH 5/7] Build only on push to master, not on PRs --- .github/workflows/docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 5ed2768fc90..82799123c60 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -1,7 +1,7 @@ name: Docs on: - pull_request: # change to 'push' + push: branches: - master From 2f3e42fef99e14421e9b79f5ae085546abb263af Mon Sep 17 00:00:00 2001 From: Chris Kleinknecht Date: Wed, 25 Sep 2019 13:51:32 -0700 Subject: [PATCH 6/7] Use sphinx.ext.githubpages --- docs/conf.py | 3 +++ tox.ini | 3 --- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index d719ebe9311..694ba7f0056 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -42,6 +42,9 @@ "sphinx.ext.viewcode", # Link to other sphinx docs "sphinx.ext.intersphinx", + # Add a .nojekyll file to the generated HTML docs + # https://help.github.com/en/articles/files-that-start-with-an-underscore-are-missing + "sphinx.ext.githubpages", ] intersphinx_mapping = {"python": ("https://docs.python.org/3/", None)} diff --git a/tox.ini b/tox.ini index b466fc38a7b..d0fb6cc2dc4 100644 --- a/tox.ini +++ b/tox.ini @@ -96,6 +96,3 @@ changedir = docs commands = sphinx-build -W --keep-going -b html -T . _build/html - ; stop jekyll from running on gh-pages - ; https://help.github.com/en/articles/files-that-start-with-an-underscore-are-missing - touch _build/html/.nojekyll From 4378744dc901c5b03e2135a03d4f4c6ccff9cbae Mon Sep 17 00:00:00 2001 From: Chris Kleinknecht Date: Wed, 25 Sep 2019 13:58:46 -0700 Subject: [PATCH 7/7] Install --upgrade tox on docs generation --- .github/workflows/docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 82799123c60..423396ea8d7 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -13,7 +13,7 @@ jobs: - uses: actions/setup-python@v1 - name: Build docs run: | - pip install tox + pip install --upgrade tox tox -e docs - name: Publish to gh-pages uses: JamesIves/github-pages-deploy-action@2.0.2