Skip to content

Commit

Permalink
Adds a GitHub Action that publishes the Parfun docs. (#19)
Browse files Browse the repository at this point in the history
  • Loading branch information
rafa-be authored Oct 8, 2024
1 parent 0c5e915 commit dbaabb3
Show file tree
Hide file tree
Showing 5 changed files with 43 additions and 23 deletions.
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]

permissions:
contents: read

jobs:
deploy:
runs-on: ubuntu-latest
permissions:
pages: write
id-token: write
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
20 changes: 0 additions & 20 deletions Makefile

This file was deleted.

2 changes: 1 addition & 1 deletion docs/requirements_docs.txt → docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
sphinx
sphinx-jsonschema
sphinx_rtd_theme
sphinx-substitution-extensions
dask[distributed]
pandas
scaler
1 change: 0 additions & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,6 @@
"sphinx.ext.doctest",
"sphinx_substitution_extensions",
"sphinx.ext.napoleon",
"sphinx-jsonschema",
]

# Add any paths that contain templates here, relative to this directory.
Expand Down
2 changes: 1 addition & 1 deletion parfun/about.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = "7.0.2"
__version__ = "7.0.3"

0 comments on commit dbaabb3

Please sign in to comment.