🔧 Add agent setup files with tox and dependency groups#59
Merged
ubmarco merged 3 commits intouseblocks:mainfrom Jan 21, 2026
Merged
🔧 Add agent setup files with tox and dependency groups#59ubmarco merged 3 commits intouseblocks:mainfrom
ubmarco merged 3 commits intouseblocks:mainfrom
Conversation
This PR adds comprehensive tooling and documentation to enable GitHub Copilot agents (and other AI coding assistants) to work effectively with the sphinx-codelinks project. ## Summary Add agent documentation, GitHub Copilot setup workflow, tox configuration for standardized development, and PEP 735 dependency groups for modern dependency management. ## Inspiration This PR follows patterns established in these repositories: - [useblocks/sphinx-needs](https://github.com/useblocks/sphinx-needs) — AGENTS.md structure, dependency groups - [executablebooks/sphinx-design](https://github.com/executablebooks/sphinx-design) — tox.ini, copilot-setup-steps.yml, commit message format - [executablebooks/MyST-Parser](https://github.com/executablebooks/MyST-Parser) — AGENTS.md sections, Sphinx integration documentation ## Changes ### New Files | File | Description | | ---- | ----------- | | `AGENTS.md` | Comprehensive guide for AI coding agents (~450 lines) with project overview, repository structure, development commands, code style guidelines, commit message format, testing guidelines, Sphinx integration flow diagram, architecture documentation, and common patterns | | `tox.ini` | Standardized tox configuration with test matrix (`py{312,313,314}-sphinx{7,8,9}`), docs, mypy, and ruff environments | | `.github/workflows/copilot-setup-steps.yml` | GitHub Copilot agent setup workflow installing uv, pre-commit, and tox | ### Modified Files | File | Changes | | ---- | ------- | | `pyproject.toml` | Added `[dependency-groups]` section with `testing`, `docs`, `mypy`, `ruff`, and `build` groups (PEP 735) | ## Details ### AGENTS.md highlights - Project overview and repository structure - Development commands (all tox-based) - Code style guidelines with markdownlint, Ruff, and Mypy - Commit message format with emoji keywords (✨, 🐛, 📚, etc.) - Sphinx integration flow with mermaid diagram and event handler table - Common patterns for adding languages, markers, CLI commands, and config options - Reference documentation with links to all dependencies ### tox.ini environments - `py{312,313,314}-sphinx{7,8,9}` — Test matrix across Python and Sphinx versions - `docs` — Documentation building with CLEAN/BUILDER env var support - `mypy` — Type checking - `ruff-check` / `ruff-fmt` — Linting and formatting ### pyproject.toml dependency groups - `testing` — pytest, syrupy, coverage tools - `docs` — Sphinx themes and documentation extensions - `mypy` — Type checking and stub packages - `ruff` — Linting/formatting - `build` — Build and packaging tools
ubmarco
approved these changes
Jan 21, 2026
ubmarco
requested changes
Jan 21, 2026
Member
ubmarco
left a comment
There was a problem hiding this comment.
tox fails for me locally
py314-sphinx7: Exception running subprocess [Errno 2] No such file or directory: 'pytest'
py314-sphinx7: exit 2 (0.00 seconds) /home/marco/git/useblocks/sphinx-test-reports> pytest tests
py314-sphinx7: FAIL ✖ in 16.04 seconds
Member
Author
|
@ubmarco yeh needs to look more like this https://github.com/executablebooks/MyST-Parser/blob/master/tox.ini Also the |
Member
Author
ubmarco
approved these changes
Jan 21, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds comprehensive tooling and documentation to enable GitHub Copilot agents (and other AI coding assistants) to work effectively with the sphinx-codelinks project.
Summary
Add agent documentation, GitHub Copilot setup workflow, tox configuration for standardized development, and PEP 735 dependency groups for modern dependency management.
Inspiration
This PR follows patterns established in these repositories:
Changes
New Files
AGENTS.mdModified Files
pyproject.toml[dependency-groups]section withtesting,docs,mypy,ruff, andbuildgroups (PEP 735)Details
AGENTS.md highlights
tox.ini environments
py{312,313,314}-sphinx{7,8,9}— Test matrix across Python and Sphinx versionsdocs— Documentation building with CLEAN/BUILDER env var supportmypy— Type checkingruff-check/ruff-fmt— Linting and formattingpyproject.toml dependency groups
testing— pytest, syrupy, coverage toolsdocs— Sphinx themes and documentation extensionsmypy— Type checking and stub packagesruff— Linting/formattingbuild— Build and packaging tools