Skip to content

Commit

Permalink
add docu workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
gituser789 committed May 8, 2024
1 parent 44cd765 commit 35dca33
Showing 1 changed file with 35 additions and 0 deletions.
35 changes: 35 additions & 0 deletions .github/workflows/sphinx_render_docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: "Sphinx: Render docs"

on: push

jobs:
build:
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: '3.8'
- uses: actions/checkout@v4
- name: Install sphinx and build documentation with sphinx
run: |
python --version
pip install sphinx sphinx_rtd_theme sphinxcontrib-email
pip install -e .
- name: Build HTML
uses: ammaraskar/sphinx-action@master
with:
docs-folder: "docs/"
- name: Upload artifacts
uses: actions/upload-artifact@v4
with:
name: html-docs
path: docs/build/html/
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
if: github.ref == 'refs/heads/main'
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/build/html

0 comments on commit 35dca33

Please sign in to comment.