Skip to content

Fix doc building and version constraints and allow manual dispatching of CI pipelines - #147

Merged
oliveira-caio merged 4 commits into
sensorium-competition:mainfrom
reneburghardt:fix-docs-and-workflow
Mar 23, 2026
Merged

Fix doc building and version constraints and allow manual dispatching of CI pipelines#147
oliveira-caio merged 4 commits into
sensorium-competition:mainfrom
reneburghardt:fix-docs-and-workflow

Conversation

@reneburghardt

@reneburghardt reneburghardt commented Mar 19, 2026

Copy link
Copy Markdown
Member

Description

  • After introduction of spikes interpolator, the building of the docs failed because readthedocs is building with python v3.9 which doesn't support numba in the specified version
  • The CI failed to detect this, because it runs in v3.12
  • I also added black and isort to dev dependency group with version constraints
  • constrained the version of pyright
  • I make use of the dev dependency group in CI to have a single place of definition for dependency versions
  • I renamed "experanto" string in readthedocs to capitalized version, matching it to other places
  • I introduced manual dispatching of CI workflows
  • The name and email of Github Actions Bot was adjusted according to https://github.com/actions/checkout?tab=readme-ov-file#push-a-commit-to-a-pr-using-the-built-in-token

… between docs CI and actual docs building, rename Experanto in docs to capitalized and allow manual dispatching of CI pipelines
Copilot AI review requested due to automatic review settings March 19, 2026 12:39
@gitnotebooks

gitnotebooks Bot commented Mar 19, 2026

Copy link
Copy Markdown

Comment thread docs/.claude/settings.local.json Outdated
Comment thread pyproject.toml

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates dependency/version constraints and CI/docs configuration to resolve documentation build failures (notably around Python/numba compatibility), align CI installs with pyproject.toml extras, and enable manual triggering of CI workflows.

Changes:

  • Pin/adjust dev-tool versions in pyproject.toml and switch CI to install via pip install -e ".[dev]".
  • Update Sphinx docs config (project name casing; extend autodoc_mock_imports) and move Read the Docs to Python 3.12.
  • Allow manual workflow_dispatch for test, ruff, and docs GitHub Actions workflows.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 5 comments.

Show a summary per file
File Description
pyproject.toml Adds dev-tool pins and a note about keeping docs mocking in sync with dependencies.
docs/source/conf.py Renames project label; extends autodoc_mock_imports.
docs/.claude/settings.local.json Adds a Claude local settings file under docs.
.readthedocs.yml Switches RTD build Python version to 3.12 and installs .[docs].
.github/workflows/test.yml Adds manual dispatch, adjusts conditions, and installs via .[dev] for jobs.
.github/workflows/ruff.yml Adds manual dispatch support and corresponding condition.
.github/workflows/docs.yml Adds manual dispatch support and corresponding condition.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread pyproject.toml
Comment thread docs/source/conf.py Outdated
Comment thread .github/workflows/test.yml
Comment thread .github/workflows/test.yml Outdated
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Comment thread .github/workflows/docs.yml
Comment thread .github/workflows/ruff.yml
Comment thread .github/workflows/test.yml
@codecov

codecov Bot commented Mar 19, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@pollytur pollytur left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@pollytur

Copy link
Copy Markdown
Contributor

@oliveira-caio please take a look :)

@oliveira-caio

Copy link
Copy Markdown
Collaborator

my bad, i thought it was closed already. looks ok.

@oliveira-caio
oliveira-caio merged commit bc1c491 into sensorium-competition:main Mar 23, 2026
6 checks passed
@reneburghardt
reneburghardt deleted the fix-docs-and-workflow branch March 23, 2026 22:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants