diff options
| author | HalfSweet <[email protected]> | 2024-09-24 20:14:31 +0800 |
|---|---|---|
| committer | GitHub <[email protected]> | 2024-09-24 20:14:31 +0800 |
| commit | 5fb7d4d0e9b586a00fa41050678150dcd90e20fc (patch) | |
| tree | 3b0173dfcd61d58c20b50d7b47eb1b97bd57451a | |
| parent | 8cb95b04cf2495c90a202fd66002abf3264fc5c6 (diff) | |
Add Github Action for Documentation Builds (#256)
| -rw-r--r-- | .github/workflows/deploy-docs.yml | 25 | ||||
| -rw-r--r-- | docs/.gitignore | 1 |
2 files changed, 26 insertions, 0 deletions
diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml new file mode 100644 index 00000000..dfc28ebc --- /dev/null +++ b/.github/workflows/deploy-docs.yml @@ -0,0 +1,25 @@ +name: Deploy docs + +on: + push: + branches: + - master + +jobs: + deploy: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v4 + with: + fetch-depth: 0 + submodules: true + - uses: ammaraskar/sphinx-action@master + with: + docs-folder: "docs/" + - uses: JamesIves/github-pages-deploy-action@v4 + with: + branch: gh-pages + folder: docs/build/html + + diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 00000000..c809c12d --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1 @@ +*build
\ No newline at end of file |