Add github action to publish docs
This commit is contained in:
22
.github/workflows/docs_publish.yml
vendored
Normal file
22
.github/workflows/docs_publish.yml
vendored
Normal file
@@ -0,0 +1,22 @@
|
|||||||
|
name: publish_docs
|
||||||
|
on: [push, pull_request, workflow_dispatch]
|
||||||
|
jobs:
|
||||||
|
docs:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v2
|
||||||
|
- uses: actions/setup-python@v2
|
||||||
|
- name: Install dependencies
|
||||||
|
run: |
|
||||||
|
pip install sphinx furo
|
||||||
|
- name: Sphinx build
|
||||||
|
run: |
|
||||||
|
sphinx-build docs/source docs/build
|
||||||
|
- name: Deploy
|
||||||
|
uses: peaceiris/actions-gh-pages@v3
|
||||||
|
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' }}
|
||||||
|
with:
|
||||||
|
publish_branch: gh-pages
|
||||||
|
github_token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
publish_dir: docs/build/
|
||||||
|
force_orphan: true
|
Reference in New Issue
Block a user