Skip to content

Commit 34d1b34

Browse files
committed
🔧 Switch to dependency groups
* Update readthedocs config * Update GitHub workflow
1 parent 5cd6a22 commit 34d1b34

File tree

5 files changed

+28
-22
lines changed

5 files changed

+28
-22
lines changed

.github/workflows/docs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ jobs:
2727
run: |
2828
uv venv
2929
echo "$PWD/.venv/bin" >> $GITHUB_PATH
30-
uv pip install -e ".[docs]"
30+
uv pip install --group=docs
3131
- name: Build HTML and check links
3232
run: |
3333
uv run make html

.readthedocs.yaml

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,10 @@ build:
1717
- graphviz
1818
tools:
1919
python: "3.12"
20+
jobs:
21+
install:
22+
- python -m pip install --upgrade pip
23+
- python -m pip install --group=docs
2024

2125
# Build documentation in the docs/ directory with Sphinx
2226
sphinx:
@@ -26,11 +30,3 @@ sphinx:
2630
formats:
2731
- epub
2832
- pdf
29-
30-
# Optionally declare the Python requirements required to build your docs
31-
python:
32-
install:
33-
- method: pip
34-
path: .
35-
extra_requirements:
36-
- docs

docs/404.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
==============
2+
Page not found
3+
==============
4+
5+
This page may have been moved.
6+
7+
Please select a page from the side menu or visit our homepage at
8+
https://www.python4data.science/en/latest/.

docs/conf.py

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232

3333
project = "Python for Data Science"
3434
author = "Veit Schiele"
35-
copyright = f"2019–2024, {author}"
35+
copyright = f"2019–2025, {author}"
3636

3737
# The full version, including alpha/beta/rc tags
3838
release = re.sub("^v", "", os.popen("git describe --abbrev=0").read().strip())
@@ -44,17 +44,18 @@
4444
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
4545
# ones.
4646
extensions = [
47-
"nbsphinx",
4847
"IPython.sphinxext.ipython_console_highlighting",
49-
# 'jupyter_sphinx.execute',
48+
# "jupyter_sphinx.execute",
49+
"nbsphinx",
50+
"notfound.extension",
5051
"sphinx.ext.autodoc",
51-
"sphinx.ext.intersphinx",
5252
"sphinx.ext.graphviz",
53+
"sphinx.ext.intersphinx",
5354
"sphinx.ext.todo",
54-
"sphinxcontrib.cairosvgconverter",
55-
"sphinxext.opengraph",
5655
"sphinx_copybutton",
5756
"sphinx_inline_tabs",
57+
"sphinxcontrib.cairosvgconverter",
58+
"sphinxext.opengraph",
5859
]
5960

6061
# Add any paths that contain templates here, relative to this directory.

pyproject.toml

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,24 +14,25 @@ classifiers = [
1414
]
1515
dependencies = []
1616

17-
[project.optional-dependencies]
17+
[dependency-groups]
1818
docs = [
19-
"sphinx<8.2",
2019
"furo",
2120
"ipython",
2221
"ipywidgets",
22+
"matplotlib",
2323
"nbsphinx",
2424
"notebook",
25-
"sphinxcontrib-svg2pdfconverter",
26-
"sphinxext.opengraph", # matplotlib is required for social cards
27-
"matplotlib",
25+
"sphinx<8.2",
2826
"sphinx-copybutton",
29-
"sphinx_inline_tabs",
3027
"sphinx-lint",
28+
"sphinx-notfound-page",
29+
"sphinx_inline_tabs",
30+
"sphinxcontrib-svg2pdfconverter",
31+
"sphinxext.opengraph", # matplotlib is required for social cards
3132
]
3233

3334
dev = [
34-
"Python4DataScience[docs]",
35+
{ include-group = "docs" },
3536
"pre-commit",
3637
"codespell",
3738
"vale",

0 commit comments

Comments
 (0)