Skip to content

ruff policy comment; RTD webhook verification in SETUP#6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nathanschepers merged 1 commit into from
Jul 31, 2026
Merged

ruff policy comment; RTD webhook verification in SETUP #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 4 additions & 0 deletions template/SETUP.md.jinja
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -71,6 +71,10 @@ Import at <https://app.readthedocs.org/> (it auto-detects `.readthedocs.yaml`).
doesn't appear in the list, use **Import Manually** with the repo URL — that bypasses the stale
discovery list. Add the incoming-webhook URL + secret under the repo's Settings → Webhooks
(events: push, create, delete) so docs rebuild on push and tags become versions.

Verify the webhook exists — `gh api repos/<org>/<name>/hooks` lists a readthedocs.org URL — and
that a subsequent push starts a second RTD build. The import's initial build runs without the
webhook, so first-build-green does not confirm the connection.
[% if publish_to_pypi %]
After the first publish, the PyPI Documentation URL fills in automatically from `[project.urls]`.
[% endif %]
Expand Down
2 changes: 2 additions & 0 deletions template/pyproject.toml.jinja
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -73,6 +73,8 @@ src = ["src", "tests"]
[% if web_service and database != "none" %]extend-exclude = ["alembic"]
[% endif %]

# Closed list via `select`, never `extend-select`: a ruff upgrade must not change
# which rules run. Widen the list deliberately, per project.
[tool.ruff.lint]
select = ["E", "F", "I", "UP", "B", "D"]

Expand Down