Skip to content

DOC: run towncrier to consolidate the 2.0.0 release notes to data #25827

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.

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
merged 2 commits into from
Feb 14, 2024

Conversation

rgommers
Copy link
Member

The first commit is purely running towncrier, no manual changes. The second commit fixes all doc build warnings I see locally.

Actually editing the 2.0.0 release notes will be a follow-up PR.

@rgommers rgommers added this to the 2.0.0 release milestone Feb 14, 2024
@charris charris merged commit 261c4c0 into numpy:main Feb 14, 2024
@charris
Copy link
Member

charris commented Feb 14, 2024

Thanks Ralf.

@rgommers rgommers deleted the doc-maint branch February 14, 2024 22:17
@seberg
Copy link
Member

seberg commented Feb 15, 2024

I think this lost the ones that were inlcuded by the previous generation in #24510? There some smaller fixups on that, but not sure they are relevant, maybe it is easier to just pull in all those fragments again.

@rgommers
Copy link
Member Author

Oh great, a tool that silently deletes content. And doesn't even have an option for merging as far as I can tell from https://towncrier.readthedocs.io/en/stable/cli.html#towncrier-build. I only checked one of the first deleted lines in the diff and saw it was moved, so I thought it was a diff display thing and didn't check the whole thing.

I'll fix this up manually, but it looks to me like it makes the tool pretty much useless then.

@mattip
Copy link
Member

mattip commented Feb 15, 2024

I think you can get a bit of a work-around by adding a line to the generated file to tell towncrier not to remove the current content. There will still be two heading lines, but they can be deleted in the inevitable cleanup.

@seberg
Copy link
Member

seberg commented Feb 15, 2024

Just doing a merge or copying things manually is probably just as well. The point is, towncrier is meant to be run exactly once.
It is running in our devdocs build so we always have a nice rendered version online. The only small wrinkle is that the local docs build shouldn't mutate the repo, so it doesn't run towncrier: Could be done I am sure. Nobody ever asked for it.

rgommers added a commit to rgommers/numpy that referenced this pull request Feb 15, 2024
Hiccup with towncrier in numpygh-25827, this puts everything back.
No actual edits beyond fixing a typo and whitespace at end of lines.

[skip actions] [skip cirrus] [skip azp]
@rgommers
Copy link
Member Author

gh-25832 should restore the missing content.

I think you can get a bit of a work-around by adding a line to the generated file

Ah good find, that seems needed. I'll see about adding that in the next PR.

The point is, towncrier is meant to be run exactly once. [...] The only small wrinkle is that the local docs build shouldn't mutate the repo, so it doesn't run towncrier

Let's fix that; this isn't a reasonable restriction and not having a local build seems bad (we'd never accept that for code, so I don't think we should for docs either). I'll see if it's easy to do.

rgommers added a commit to rgommers/numpy that referenced this pull request Mar 4, 2024
This allows accumulating snippets into the main release notes file and
committing the result during a release cycle. It will also make Sphinx
formatting errors, cross-link issues, etc. visible when docs get built
locally. This will allow fixing them as we go, rather than leaving it
broken in devdocs and then having to fix it in one go once `towncrier`
is run once right before or after creating a release branch.

xref numpygh-25921 and numpygh-25827 for recent issues with this.

[skip azp] [skip actions] [skip cirrus]
rgommers added a commit to rgommers/numpy that referenced this pull request Mar 5, 2024
This allows accumulating snippets into the main release notes file and
committing the result during a release cycle. It will also make Sphinx
formatting errors, cross-link issues, etc. visible when docs get built
locally. This will allow fixing them as we go, rather than leaving it
broken in devdocs and then having to fix it in one go once `towncrier`
is run once right before or after creating a release branch.

xref numpygh-25921 and numpygh-25827 for recent issues with this.

[skip azp] [skip actions] [skip cirrus]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants