Skip to content

Commit

Permalink
ci: Generate documentation on every push to main
Browse files Browse the repository at this point in the history
This helps having the changes to documentation be visible faster, which
is especially useful when we make rapid and frequent changes to it.

Signed-off-by: Gus Monod <[email protected]>
  • Loading branch information
sarahmonod committed May 20, 2024
1 parent 3edc7ef commit 8425835
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 31 deletions.
38 changes: 38 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: Publish docs

on:
push:
branches:
- main

jobs:
publish_docs:
name: Publish docs
runs-on: ubuntu-latest
#if: github.event_name == 'release' && github.event.action == 'published'
permissions:
contents: write
steps:
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: "3.10"
- name: Set up dependencies
run: |
sudo apt-get update
sudo apt-get install -qy libdw-dev libelf-dev pkg-config
- name: Install Python dependencies
run: |
python3 -m pip install -r requirements-extra.txt
- name: Install Package
run: |
python3 -m pip install -e .
- name: Build docs
run: |
make docs
- name: Publish docs to GitHub Pages
uses: JamesIves/github-pages-deploy-action@v4
with:
folder: docs/_build/html
single-commit: true
31 changes: 0 additions & 31 deletions .github/workflows/lint_and_docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,34 +28,3 @@ jobs:
run: |
towncrier build --version 99.99 --name pystack --keep
make docs
publish_docs:
name: Publish docs
runs-on: ubuntu-latest
if: github.event_name == 'release' && github.event.action == 'published'
permissions:
contents: write
steps:
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: "3.10"
- name: Set up dependencies
run: |
sudo apt-get update
sudo apt-get install -qy libdw-dev libelf-dev pkg-config
- name: Install Python dependencies
run: |
python3 -m pip install -r requirements-extra.txt
- name: Install Package
run: |
python3 -m pip install -e .
- name: Build docs
run: |
make docs
- name: Publish docs to GitHub Pages
uses: JamesIves/github-pages-deploy-action@v4
with:
folder: docs/_build/html
single-commit: true

0 comments on commit 8425835

Please sign in to comment.