Skip to content
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

Switch from using rubric in release notes #1346

Merged
merged 9 commits into from
Jul 1, 2024

Conversation

ivirshup
Copy link
Member

Just something that always bothered me. Plus if we want to put release notes on github it'd be nice to have less that needs reformatting.

@ivirshup ivirshup added the docs label Jan 26, 2024
@ivirshup ivirshup added this to the 0.10.6 milestone Jan 26, 2024
Copy link

codecov bot commented Jan 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.44%. Comparing base (c0b4e8f) to head (72b60ff).
Report is 73 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1346   +/-   ##
=======================================
  Coverage   84.44%   84.44%           
=======================================
  Files          36       36           
  Lines        5747     5747           
=======================================
  Hits         4853     4853           
  Misses        894      894           

@flying-sheep
Copy link
Member

Good call! We should also make sure that people can link to patch versions.

For some reason, anchors like #version-0-10 exist, while 0.10.5 currently has the (unstable) anchor #id5

@ivirshup
Copy link
Member Author

For some reason, anchors like #version-0-10 exist, while 0.10.5 currently has the (unstable) anchor #id5

I have a local commit for this

The problem is that sphinx can't do ids that start with numbers, so I added "Version". I would also like to keep the date out of it so it just looks like

https://anndata.readthedocs.io/en/latest/release-notes/index.html#version-0-10-5

But that might require putting the date on a separate line, which I'd rather not do.

@flying-sheep
Copy link
Member

Yeah, that would be great! Mabye we can define the smaller role in a way that hides it from Sphinx’ slug generation mechanism. Now that we use scanpydoc again, centralizing that is easy.

@ivirshup ivirshup modified the milestones: 0.10.6, 0.10.7 Mar 11, 2024
@flying-sheep flying-sheep modified the milestones: 0.10.7, 0.10.8 Apr 9, 2024
@flying-sheep flying-sheep modified the milestones: 0.10.8, 0.10.9 Jun 18, 2024
@flying-sheep flying-sheep marked this pull request as ready for review July 1, 2024 12:40
Comment on lines -99 to -100
# Don’t allow broken links. DO NOT CHANGE THIS LINE, fix problems instead.
app.warningiserror = True
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

By now, this is enforced in .readthedocs.yml

Having it twice helped against the most egregious offenders, but by now I’m in a more active role and can prevent the other instance from being removed.

@@ -1,8 +1,45 @@
# Release notes

```{include} /release-notes/release-latest.md
(v0.11)=
Copy link
Member

@flying-sheep flying-sheep Jul 1, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the v is load-bearing, without it the generated HTML anchors are generic id40 ones as mentioned above.

We could also use myst_heading_slug_func

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this release doesn’t actually exist

@flying-sheep flying-sheep merged commit 2e21490 into scverse:main Jul 1, 2024
8 of 13 checks passed
@scverse scverse deleted a comment from lumberbot-app bot Jul 1, 2024
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.

2 participants