Conversation
Update project infraestructure
Update docs and enable rtd
There was a problem hiding this comment.
Pull request overview
Release merge for v0.0.7 that modernizes packaging, consolidates dev tooling, updates CI, and restructures documentation to support Read the Docs.
Changes:
- Migrates packaging metadata to
pyproject.tomland removes legacysetup.py/requirements.txt. - Adds shared shell helpers (
tools/common.sh) and updates lint/format/test scripts to respect the repo virtualenv and a computed base ref. - Reorganizes Sphinx docs (new
docs/layout + RTD config) and expands GitHub Actions Python matrix through 3.13 with draft-PR handling.
Reviewed changes
Copilot reviewed 23 out of 30 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| tools/test.sh | Runs pytest via the resolved Python interpreter and forwards CLI args. |
| tools/lint.sh | New Ruff lint/format-check wrapper with --all / --changed scopes. |
| tools/format.sh | Formats changed Python targets using Ruff via resolved interpreter. |
| tools/docs.sh | Removed legacy docs build script. |
| tools/common.sh | New shared helpers (repo root, python resolution, base-ref resolution, target selection). |
| tools/analyse.sh | Removed legacy Ruff analysis script. |
| src/cmdcraft/init.py | Bumps package version to 0.0.7. |
| setup.py | Removed legacy setuptools configuration. |
| requirements.txt | Removed legacy pinned dependency file. |
| README.rst | Updates wording, image path, CI badge, and contributing link. |
| pyproject.toml | Adds PEP 621 project metadata + tooling config (setuptools dynamic version, git-cliff, Ruff target version). |
| docs/source/pages/documentation.rst | Removed old docs-source page (docs moved to new layout). |
| docs/source/index.rst | Removed old Sphinx root index (replaced by docs/index.rst). |
| docs/source/conf.py | Removed old Sphinx config (replaced by docs/conf.py). |
| docs/pages/intro/known_issues.rst | Adds “Known Issues” page. |
| docs/pages/intro/index.rst | Adds intro toctree. |
| docs/pages/intro/getting_started.rst | Adds installation + first app guide. |
| docs/pages/howto/crafting.rst | Adds “Crafting your Commands” how-to page. |
| docs/pages/documentation.rst | New API docs page using automodule directives. |
| docs/pages/contributing.rst | Adds local lint guidance section. |
| docs/pages/changelog.rst | Adds v0.0.7 changelog entry + fixes RST underlines. |
| docs/Makefile | Replaces generic Sphinx makefile with explicit apidoc and html targets. |
| docs/make.bat | Removes Windows Sphinx make script. |
| docs/index.rst | New Sphinx root index + toctree for the reorganized docs. |
| docs/images/example.gif | Moves/adds example GIF under the new docs layout. |
| docs/conf.py | New Sphinx configuration aligned with RTD and autosummary/typehints. |
| .readthedocs.yaml | Adds RTD build configuration pointing at docs/conf.py. |
| .gitignore | Updates ignores for .venv/, build outputs, and Sphinx build dirs. |
| .github/workflows/unit_tests.yml | Expands CI matrix to Python 3.13, adds lint step, editable install, draft-PR gating, and README render validation. |
| .github/pull_request_template.md | Adds PR template with validation checklist and review guidance. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+41
to
+48
| FILES=$(tool_python_targets_for_scope "$scope") | ||
|
|
||
| if [ -z "${FILES}" ]; then | ||
| exit 0 | ||
| fi | ||
|
|
||
| "${PYTHON_BIN}" -m ruff check ${FILES} | ||
| "${PYTHON_BIN}" -m ruff format --check ${FILES} No newline at end of file |
Comment on lines
+22
to
+23
| "${PYTHON_BIN}" -m ruff check --fix ${FILES} | ||
| "${PYTHON_BIN}" -m ruff format ${FILES} No newline at end of file |
| python -m pip install . ruff coverage pytest readme_renderer | ||
| - name: Analysis | ||
| run: ./tools/analyse.sh | ||
| pip install -e '.[dev]' |
|
|
||
| - `./tools/lint.sh --changed` | ||
| - `./tools/test.sh -q` | ||
| - `./tools/docs.sh` (if docs or public API changed) |
Comment on lines
10
to
12
|
|
||
| .. image:: docs/source/images/example.gif | ||
| .. image:: docs/images/example.gif | ||
|
|
| ============ | ||
|
|
||
| Contributions are welcome! Please start by reading the `Contributing Guidelines <CONTRIBUING.rst>`_ file. | ||
| Contributions are welcome! Please start by reading the `Contributing Guidelines <docs/pages/contributing.rst>`_ file. |
Weinsen
added a commit
that referenced
this pull request
May 16, 2026
Merge release v0.0.7 into `master` branch
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.
Summary
Merge release v0.0.7 into main branch
Changelog
pyproject.tomland removesetup.pyplusrequirements.txt.lint/testscripts that honor the repository virtual environment and base ref.