summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFederico Caselli <cfederico87@gmail.com>2023-04-23 21:41:05 +0200
committerFederico Caselli <cfederico87@gmail.com>2023-04-23 21:41:05 +0200
commit63a3813f828d1f3488c7e64322c6feefafcdd95f (patch)
tree638aaa50e45f73ee3d155bb68687c8155d85c7a2
parent32a17e60ba63f0278a754e1ab7e9ebf9460e07c5 (diff)
downloadsqlalchemy-63a3813f828d1f3488c7e64322c6feefafcdd95f.tar.gz
Add workflow to build docs
Change-Id: I3f5ad6f3832ea56aba72c62f6bd2092288dcb5c9
-rw-r--r--.github/workflows/build-docs.yaml50
1 files changed, 50 insertions, 0 deletions
diff --git a/.github/workflows/build-docs.yaml b/.github/workflows/build-docs.yaml
new file mode 100644
index 000000000..4313de777
--- /dev/null
+++ b/.github/workflows/build-docs.yaml
@@ -0,0 +1,50 @@
+name: Build docs
+
+on:
+ # run on push in main or rel_* branches excluding changes are only on example folders
+ push:
+ branches:
+ - main
+ - "rel_*"
+ # branches used to test the workflow
+ - "workflow_test_*"
+ paths-ignore:
+ - "examples/**"
+
+permissions:
+ contents: read
+
+jobs:
+ run-test:
+ name: build-docs
+ runs-on: "ubuntu-latest"
+
+ steps:
+ - name: Checkout repo
+ uses: actions/checkout@v3
+
+ - name: Set up python
+ uses: actions/setup-python@v4
+ with:
+ python-version: "3.11"
+
+ - name: Install dependencies
+ run: |
+ python -m pip install --upgrade pip
+ pip install --requirement doc/build/requirements.txt
+ pip list
+
+ - name: Build docs
+ run: |
+ cd doc/build
+ make html
+
+ - name: Create artifact
+ run: |
+ tar czf docs.tgz doc/build/output/html
+
+ - name: Upload artifact
+ uses: actions/upload-artifact@v3
+ with:
+ name: docs-archive
+ path: docs.tgz