Skip to content

Commit

Permalink
Build and host docs via github action (#167)
Browse files Browse the repository at this point in the history
  • Loading branch information
c24t authored Sep 25, 2019
1 parent e14076d commit 81cd8d6
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 0 deletions.
23 changes: 23 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: Docs

on:
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 --upgrade tox
tox -e docs
- name: Publish to gh-pages
uses: JamesIves/github-pages-deploy-action@2.0.2
env:
ACCESS_TOKEN: ${{ secrets.DocsPushToken }}
BRANCH: gh-pages
FOLDER: docs/_build/html/
3 changes: 3 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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)}
Expand Down

0 comments on commit 81cd8d6

Please sign in to comment.