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

change asdf standard changelog entries to notes #1830

Merged
merged 3 commits into from
Aug 20, 2024

Conversation

braingram
Copy link
Contributor

@braingram braingram commented Aug 19, 2024

Description

Since towncrier renders sub-sections with - and we include out CHANGES.rst in the docs we run into issues due to previous sub-sections with ^ marking the then-current ASDF-standard version.

This PR changes the ^ sub-sections to .. note:: to avoid the conflict with towncrier.

Checklist:

  • pre-commit checks ran successfully
  • tests ran successfully
  • for a public change, added news fragment (changes/<PR#>.<changetype>.rst)
  • for a public change, updated documentation
  • for any new features, unit tests were added

@braingram braingram marked this pull request as ready for review August 19, 2024 22:00
@braingram braingram requested a review from a team as a code owner August 19, 2024 22:00
@braingram
Copy link
Contributor Author

@zacharyburnett I think something is not quite right with the towncrier configuration. When I run towncrier build --draft I see:

Loading template...
Finding news fragments...
Rendering news fragments...
Draft only -- nothing has been written.
What is seen below is what would be written.

3.4.1.dev6+gfe07e2df.d20240807 (2024-08-19)
===========================================

Misc
----

- `#1828 <https://github.com/asdf-format/asdf/pull/1828>`_, `#1830
  <https://github.com/asdf-format/asdf/pull/1830>`_

It appears towncrier is throwing away the fragment contents. This can be seen in the docs too: https://asdf--1830.org.readthedocs.build/en/1830/asdf/changes.html#dev41-ge304a781-2024-08-19

@braingram
Copy link
Contributor Author

I mistakenly thought misc fragments would be shown. This isn't the case (they default to showcontent=False). I'll update this PR to use doc instead.

I'd also like to see if we can make misc show content (without having to redefine all the default sections). It seems a little silly to write a fragment that will later be thrown out.

@zacharyburnett
Copy link
Member

I mistakenly thought misc fragments would be shown. This isn't the case (they default to showcontent=False). I'll update this PR to use doc instead.

I'd also like to see if we can make misc show content (without having to redefine all the default sections). It seems a little silly to write a fragment that will later be thrown out.

that's a good point; we will unfortunately have to redefine all the non-default fragment types, but that shouldn't be too difficult

@braingram braingram merged commit e3d708d into asdf-format:main Aug 20, 2024
32 checks passed
@braingram braingram deleted the fix_rtd branch August 20, 2024 14:29
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