Skip to content

Commit

Permalink
Install sphinx test dependencies in all CI testing jobs (pydata#1772)
Browse files Browse the repository at this point in the history
* CI: install sphinx test deps always

* fix it right this time

* pin sphinx<7.3 for site builds

* Fix Sphinx version

* Pin Sphinx in pyproject.toml

* bump ablog; unpin sphinx

---------

Co-authored-by: Tania Allard <taniar.allard@gmail.com>
  • Loading branch information
2 people authored and ivanov committed Jun 4, 2024
1 parent daaab21 commit 5d4a724
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 7 deletions.
4 changes: 3 additions & 1 deletion .github/workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -45,14 +45,16 @@ jobs:
matrix:
os: [ubuntu-latest]
python-version: ["3.9", "3.10", "3.11", "3.12"]
sphinx-version: [""]
sphinx-version: ["rls"]
include:
# macos test
- os: macos-latest
python-version: "3.12"
sphinx-version: "rls"
# windows test
- os: windows-latest
python-version: "3.12"
sphinx-version: "rls"
# old Sphinx test
- os: ubuntu-latest
python-version: "3.9"
Expand Down
4 changes: 2 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ dynamic = ["version"]
readme = "README.md"
requires-python = ">=3.9"
dependencies = [
"sphinx>=5.0",
"sphinx>=5",
"beautifulsoup4",
"docutils!=0.17.0",
"packaging",
Expand Down Expand Up @@ -59,7 +59,7 @@ doc = [
"sphinx-autoapi>=3.0.0",
# For examples section
"myst-parser",
"ablog>=0.11.0rc2",
"ablog>=0.11.8",
"jupyter_sphinx",
"pandas",
"plotly",
Expand Down
8 changes: 4 additions & 4 deletions tools/github_actions_install.sh
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@
# ($2) is an extra dependency (currently just nox on one run)
set -eo pipefail
export PYTHONUTF8=1
if [[ "$SPHINX_VERSION" == "" ]]; then
SPHINX_INSTALL=""
if [[ "$SPHINX_VERSION" == "rls" ]]; then
SPHINX_INSTALL="sphinx[test]"
elif [[ "$SPHINX_VERSION" == "dev" ]]; then
SPHINX_INSTALL="sphinx[test]@https://codeload.github.com/sphinx-doc/sphinx/zip/refs/heads/master"
elif [[ "$SPHINX_VERSION" == "old" ]]; then
SPHINX_INSTALL="sphinx[test]==6.1.0"
else # not used currently but easy enough
SPHINX_INSTALL="sphinx[test]==$SPHINX_VERSION"
else # for the "build site" jobs
SPHINX_INSTALL="sphinx<7.3"
fi
set -x # print commands
python -m pip install --upgrade pip wheel setuptools
Expand Down

0 comments on commit 5d4a724

Please sign in to comment.