Skip to content

ci: try to improve release docs#1051

Merged
gaborbernat merged 2 commits into
mainfrom
henryiii/fix/docs
Apr 22, 2026
Merged

ci: try to improve release docs#1051
gaborbernat merged 2 commits into
mainfrom
henryiii/fix/docs

Conversation

@henryiii

Copy link
Copy Markdown
Contributor

Description

This should hopefully work better, not producing broken docs on release

Changelog

  • Added changelog fragment: docs/changelog/<pr_number>.<type>.rst
    • Types: feature, bugfix, doc, removal, misc
    • Example: 123.feature.rst containing Add custom backend support - by :user:`yourname`

Checklist

  • Tests pass locally (tox)
  • Code follows project style (tox -e fix)
  • Type checks pass (tox -e type)
  • Documentation builds (tox -e docs)

This should hopefully work better, not producing broken docs on release

Signed-off-by: Henry Schreiner <henryfs@princeton.edu>
@henryiii

Copy link
Copy Markdown
Contributor Author

pre-commit.ci autofix

@henryiii

Copy link
Copy Markdown
Contributor Author

I don't understand why I couldn't get this to reformat locally, though.

@gaborbernat gaborbernat merged commit cb33511 into main Apr 22, 2026
71 checks passed
@gaborbernat gaborbernat deleted the henryiii/fix/docs branch April 22, 2026 23:24
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.

2 participants