Skip to content

Commit

Permalink
Update package versions for readthedocs (#339)
Browse files Browse the repository at this point in the history
* Update readthedocs python version to 3.12
* Update readthedocs poetry version to 1.8.3
  • Loading branch information
sjperkins authored Nov 7, 2024
1 parent 438e024 commit de57456
Show file tree
Hide file tree
Showing 3 changed files with 41 additions and 7 deletions.
22 changes: 22 additions & 0 deletions .github/workflows/readthedocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# .github/workflows/documentation-links.yml

name: readthedocs/actions
on:
pull_request_target:
types:
- opened
# Execute this action only on PRs that touch
# documentation files.
# paths:
# - "doc/**"

permissions:
pull-requests: write

jobs:
documentation-links:
runs-on: ubuntu-latest
steps:
- uses: readthedocs/actions/preview@v1
with:
project-slug: "dask-ms"
4 changes: 4 additions & 0 deletions HISTORY.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@
History
=======

X.Y.Z (YYYY-MM-DD)
------------------
* Update readthedocs version (:pr:`339`)

0.2.22 (2024-11-07)
------------------
* Pin minimum version of katdal to 0.23 (:pr:`337`)
Expand Down
22 changes: 15 additions & 7 deletions readthedocs.yml
Original file line number Diff line number Diff line change
@@ -1,20 +1,28 @@
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Set the version of Python and other tools you might need
# Set the OS, Python version and other tools you might need
build:
os: ubuntu-20.04
tools: {python: "3.9"}
os: ubuntu-22.04
tools:
python: "3.12"
jobs:
post_create_environment:
# Install poetry
# https://python-poetry.org/docs/#installing-manually
- pip install poetry==1.8.3
post_install:
- pip install poetry==1.7.1
- poetry config virtualenvs.create false
- poetry install --with docs
# Install dependencies with 'docs' dependency group
# https://python-poetry.org/docs/managing-dependencies/#dependency-groups
# VIRTUAL_ENV needs to be set manually for now.
# See https://github.com/readthedocs/readthedocs.org/pull/11152/
- VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH poetry install --with docs

# Build documentation in the docs/ directory with Sphinx
# Build documentation in the "docs/" directory with Sphinx
sphinx:
configuration: docs/conf.py
fail_on_warning: false

0 comments on commit de57456

Please sign in to comment.