summaryrefslogtreecommitdiffstats
path: root/.github/workflows/docs_publish.yml
diff options
context:
space:
mode:
authorLibravatarUnit 193 <unit193@unit193.net>2024-11-20 01:17:40 -0500
committerLibravatarUnit 193 <unit193@unit193.net>2024-11-20 01:17:40 -0500
commit3e3ebe586385a83b10c8f1d0b9ba9b67c8b56d2f (patch)
tree5682f748fc9867166043734aad44e1734d16abeb /.github/workflows/docs_publish.yml
parentfa197fe27b8a03bbf4504476f842956ece2c76c9 (diff)
New upstream version 2.0.0.upstream/2.0.0
Diffstat (limited to '.github/workflows/docs_publish.yml')
-rw-r--r--.github/workflows/docs_publish.yml32
1 files changed, 32 insertions, 0 deletions
diff --git a/.github/workflows/docs_publish.yml b/.github/workflows/docs_publish.yml
new file mode 100644
index 0000000..af146b2
--- /dev/null
+++ b/.github/workflows/docs_publish.yml
@@ -0,0 +1,32 @@
+name: build and publish docs
+
+on:
+ push:
+ tags:
+ - "v*"
+ branches: # for testing
+ - main
+
+jobs:
+ build:
+ name: build and publish docs
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v4
+
+ - name: Set up Python 3.12
+ uses: actions/setup-python@v5.3.0
+ with:
+ python-version: 3.12
+
+ - name: Install sphinx
+ run: pip install sphinx
+
+ - name: Build docs
+ run: cd docs && make html
+
+ - name: Publish docs to GitHub Pages
+ uses: peaceiris/actions-gh-pages@v4
+ with:
+ github_token: ${{ secrets.GITHUB_TOKEN }}
+ publish_dir: docs/build/html