Skip to content

Commit

Permalink
Merge pull request #17 from rafa-be/documentation_to_github_pages
Browse files Browse the repository at this point in the history
Adds a GitHub Action that publishes the Pargraph docs.
  • Loading branch information
JamieSlome authored Oct 10, 2024
2 parents 2372078 + 8ce1401 commit 6fa4785
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 1 deletion.
41 changes: 41 additions & 0 deletions .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: Publish documentation to GitHub Pages

on:
release:
types: [created]
workflow_dispatch:

permissions:
contents: read
pages: write
id-token: write

jobs:
deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4

- name: Set up Python 3.8
uses: actions/setup-python@v5
with:
python-version: "3.8"

- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r requirements.txt
pip install -r docs/requirements.txt
- name: Build documentation
run: cd docs && make html

- name: Upload Pages artifact
uses: actions/upload-pages-artifact@v3
with:
path: './docs/build/html'

- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
2 changes: 1 addition & 1 deletion pargraph/about.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = "0.8.2"
__version__ = "0.8.3"

0 comments on commit 6fa4785

Please sign in to comment.