Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,26 +31,26 @@ jobs:

- name: Run mypy
run: |
uv -v run mypy
uv -v run --group=doc mypy

- name: Build & Install
run: |
uv -v build
uv -v pip install dist/scio_pypi-1.0.2.dev0-py3-none-any.whl

- name: Build docs (Posix)
if: matrix.os != 'windows-latest' && matrix.python-version != '3.14' # github.com/ThalesGroup/scio/issues/38
if: matrix.os != 'windows-latest'
env:
SPHINXOPTS: --fail-on-warning
run: |
uv -v run make -C docs
uv -v run --group=doc make -C docs

- name: Build docs (Windows)
if: matrix.os == 'windows-latest' && matrix.python-version != '3.14' # github.com/ThalesGroup/scio/issues/38
if: matrix.os == 'windows-latest'
env:
SPHINXOPTS: --fail-on-warning
run: |
uv -v run cmd /c "docs\\make.bat"
uv -v run --group=doc cmd /c "docs\\make.bat"

- name: Run pytest
id: run-pytest
Expand Down
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ For developers using `uv`, these can easily be checked with the following.
```bash
# From root directory
uv run pytest
uv run mypy
uv run mypy # Use `uv run --group=doc mypy` if doc was updated
uvx ruff format --diff
uvx ruff check
```
Expand All @@ -98,12 +98,12 @@ If your contribution changes the documentation, you can rebuild it with the foll

```bash
# Ubuntu or MacOS
uv run make -C docs
uv run --group=doc make -C docs
```

```powershell
# Windows
uv run cmd /c "docs\make.bat"
uv run --group=doc cmd /c "docs\make.bat"
```

#### First time codebase contributors
Expand Down
2 changes: 1 addition & 1 deletion docs/.readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ build:
- pip install uv
# Clone the repo hub first to avoid log in sphinx-gallery tutorials
- git clone --branch hub https://github.com/ThalesGroup/scio.git ~/.cache/torch/hub/ThalesGroup_scio_hub
- uv run make -C docs
- uv run --group=doc make -C docs
- mkdir -p $READTHEDOCS_OUTPUT
- mv docs/_build/html $READTHEDOCS_OUTPUT

Expand Down
12 changes: 8 additions & 4 deletions docs/src/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,18 @@

import torch
from paramclasses import IMPL, MISSING, isparamclass
from sphinx.application import Sphinx
from sphinx.util import logging
from sphinx_gallery.sorting import ExplicitOrder # type: ignore[import-untyped]
from sphinx.application import Sphinx # type: ignore[import-not-found, unused-ignore]
from sphinx.util import logging # type: ignore[import-not-found, unused-ignore]
from sphinx_gallery.sorting import ( # type: ignore[import-not-found, import-untyped, unused-ignore]
ExplicitOrder,
)

if TYPE_CHECKING:
from re import Match

from sphinx.ext.autodoc import _AutodocObjType # noqa: TC004 (unclear...)
from sphinx.ext.autodoc import ( # type: ignore[import-not-found, unused-ignore]
_AutodocObjType, # noqa: TC004 (unclear...)
)

import scio

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,6 @@
# .. hint:: We recommend reading
# :doc:`/auto_tutorials/inferring_with_confidence` first.
#
# .. attention:: At the time of this release, the third-party library
# `datasets <https://github.com/huggingface/datasets>`_ may not be
# fully compatible with Python 3.14 yet. If necessary, use older
# Python versions. For more information, see `this issue
# <https://github.com/ThalesGroup/scio/issues/38>`_.
#
# In this tutorial, we use the
# :doc:`/api_references/eval/classification` API from ``scio.eval`` to
# compare several confidence score algorithms in a classification setup,
Expand Down
11 changes: 7 additions & 4 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -46,17 +46,20 @@ dependencies = [
"torch>=2.6",
"torchinfo>=1.8",
]

[dependency-groups]
dev = [
"datasets>=4.3.0",
"mypy>=1.17",
"mypy-extensions>=1.1",
"myst-parser>=4.0.1",
"pandas-stubs>=2.2.3.241126",
"pydata-sphinx-theme>=0.16.1",
"pytest>=8.3.4",
"pytest>=9",
"pytest-cov>=6",
"ruamel-yaml>=0.18.7",
]
doc = [
"datasets>=4.4.0",
"myst-parser>=4.0.1",
"pydata-sphinx-theme>=0.16.1",
"sphinx>=8.2.3",
"sphinx-copybutton>=0.5.2",
"sphinx-design>=0.6.1",
Expand Down
746 changes: 368 additions & 378 deletions uv.lock

Large diffs are not rendered by default.