Skip to content

Commit

Permalink
add docs build on pr
Browse files Browse the repository at this point in the history
update sphinx to modern stable version

added publishing docs from pr to gh pages
  • Loading branch information
Andrey Kolkov committed Apr 27, 2021
1 parent b03119d commit 6fc2240
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 1 deletion.
18 changes: 18 additions & 0 deletions .github/workflows/docs-build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: "Sphinx Docs Check"
on:
- pull_request

jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- uses: ammaraskar/sphinx-action@master
with:
docs-folder: "./"
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: build/html/
commit_message: "branch: ${{ github.head_ref }}"
2 changes: 1 addition & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Pillow
Sphinx==1.8.5
Sphinx==3.5.4
sphinx-rtd-theme
sphinxcontrib-httpdomain
sphinxcontrib-images
Expand Down

0 comments on commit 6fc2240

Please sign in to comment.