Skip to content

Improve release documentaiton#257

Merged
lan496 merged 7 commits intospglib:developfrom
LecrisUT:changelog
Oct 30, 2023
Merged

Improve release documentaiton#257
lan496 merged 7 commits intospglib:developfrom
LecrisUT:changelog

Conversation

@LecrisUT
Copy link
Copy Markdown
Collaborator

@LecrisUT LecrisUT commented Mar 3, 2023 •
edited
Loading

Adapted Keep-a-changelog format

@LecrisUT LecrisUT force-pushed the changelog branch 2 times, most recently from ff83c5f to 176f3fb Compare March 3, 2023 17:47
@LecrisUT LecrisUT mentioned this pull request Mar 3, 2023
Merged
@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Mar 3, 2023 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (bf0b4b7) 83.55% compared to head (16a1efd) 83.65%.

Additional details and impacted files 
@@             Coverage Diff             @@
##           develop     #257      +/-   ##
===========================================
+ Coverage    83.55%   83.65%   +0.10%     
===========================================
  Files           24       24              
  Lines         8154     8144      -10     
===========================================
  Hits          6813     6813              
+ Misses        1341     1331      -10
Flag Coverage Δ
c_api 76.43% <ø> (ø)
fortran_api 56.29% <ø> (ø)
python_api 80.54% <ø> (+0.12%) ⬆️
unit_tests 1.24% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

see 1 file with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@LecrisUT
Copy link
Copy Markdown
Collaborator Author

LecrisUT commented Mar 3, 2023 •
edited
Loading

~~The reference page is broken? ~~ Fixed with 8d76e3c

@LecrisUT LecrisUT mentioned this pull request Mar 4, 2023
Merged
@LecrisUT LecrisUT requested a review from lan496 April 6, 2023 14:28
@lan496
Copy link
Copy Markdown
Member

lan496 commented Jun 17, 2023

@LecrisUT Sorry for the late reply. Can you rebase this PR? I suspect the combination of Sphinx>6 and sphinx-bibtex<=2.5.0 may generate invalid HTML.

@LecrisUT
Copy link
Copy Markdown
Collaborator Author

LecrisUT commented Jun 17, 2023

@LecrisUT Sorry for the late reply. Can you rebase this PR? I suspect the combination of Sphinx>6 and sphinx-bibtex<=2.5.0 may generate invalid HTML.

I have kinda fixed the reference by not having them numerically numbered. I forgot to check if cited references are properly linked though. I can try again with other sphinx-bibtex.

Also I have since got some more experience with how other projects manage their changelogs: reference. I think that would be an easy format to have. We can use it for just the big-picture changes and it's less obscure than the yaml format here. What I didn't figure out yet though is how to update the fields when a new release is pushed. I can make it to push changelog update commits after the tagged release and have the changelog format as:

## Current release
### Project related
- added my cat to the contributors list

## Version 3.4.10 (1970-01-01)
### Bug fixes
- my cat caught a big cockroach

Where the CI adds ## Version x.y.z (date) jus below ,## Current release` after each release (excluding pre-releases).

Wdyt, sounds manageable?

@LecrisUT LecrisUT self-assigned this Jun 17, 2023
@LecrisUT
Copy link
Copy Markdown
Collaborator Author

LecrisUT commented Jun 17, 2023 •
edited
Loading

@LecrisUT Sorry for the late reply. Can you rebase this PR? I suspect the combination of Sphinx>6 and sphinx-bibtex<=2.5.0 may generate invalid HTML.

Oh about this one. See #246, I will add that one as a dependency for this. Nevermind, that does not contain the fix I was thinking of, it is in this PR.

Ok, so I did some tests locally and it should be related to docutils (see this issue). It should be fixed in docutils 0.20.1, but it seems I need to check why rtd is failing dependencies (oh it's book theme :()

@LecrisUT LecrisUT force-pushed the changelog branch 2 times, most recently from 688fddc to 7b40377 Compare June 17, 2023 21:06
@LecrisUT LecrisUT marked this pull request as draft June 17, 2023 21:08
@lan496
Copy link
Copy Markdown
Member

lan496 commented Jun 18, 2023

Yeah, I'm also waiting for a newer version of sphinx-bibtex to avoid docutils issues for other projects...

@LecrisUT
Copy link
Copy Markdown
Collaborator Author

LecrisUT commented Jun 18, 2023

Yeah, I'm also waiting for a newer version of sphinx-bibtex to avoid docutils issues for other projects...

Note that this issue is in docutils not sphinx-bibtex. You have to pull in sphinx 7 that bumps docutils version to 0.20 otherwise this issue is not solved on the sphinx-bibtex side. On this side it's only sphinx-book-theme that is blocking us from upgrading to sphinx 7. Other themese like furo already support the latest version. Well technically there's sphinx-design as well, but that one is easily fixed.

@LecrisUT LecrisUT force-pushed the changelog branch 2 times, most recently from 398a846 to 41dbc70 Compare June 19, 2023 13:55
@LecrisUT LecrisUT mentioned this pull request Jun 20, 2023
Open
@lan496 lan496 mentioned this pull request Sep 6, 2023
Merged
@LecrisUT LecrisUT mentioned this pull request Oct 28, 2023
Closed
2 tasks
LecrisUT and others added 3 commits October 29, 2023 19:32
LecrisUT and others added 3 commits October 29, 2023 19:46
@LecrisUT
Reformat ChangeLog.md
e714669 
Signed-off-by: Cristian Le <[email protected]>
@LecrisUT
Bump sphinx, bibtex and myst-parser
c470790 
Fixes bib reference issue

Signed-off-by: Cristian Le <[email protected]>
Signed-off-by: Cristian Le <[email protected]>
Signed-off-by: Cristian Le <[email protected]>
@LecrisUT
Simplify conf.py
c438104 
Signed-off-by: Cristian Le <[email protected]>
@LecrisUT LecrisUT marked this pull request as ready for review October 29, 2023 19:13
@LecrisUT
[Temp] Use sphinx-book-theme fork
16a1efd 
This needs to be removed before publishing to PyPI. Unfortunately RTD does not seem to have a way to install individual dependencies?

Signed-off-by: Cristian Le <[email protected]>
lan496
lan496 approved these changes Oct 30, 2023
View reviewed changes
Copy link
Copy Markdown
Member

@lan496 lan496 left a comment

Choose a reason for hiding this comment

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

Thank you for your hard work in supporting Sphinx 7 (executablebooks/sphinx-book-theme#744)! LGTM for the contents.
I am not sure about the frequency of pre-releases in sphinx-book-theme, but it may be better to wait before we merge this PR?

doc/README.md Outdated
Python>=3.8 required for `importlib.metadata`.
```shell
$ pip install ".[docs]"
$ python3 scripts/generate_changelog.py --type local
Copy link
Copy Markdown
Member

@lan496 lan496 Apr 7, 2023

Choose a reason for hiding this comment

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

local is not contained in choices for --type. Maybe adding it to choices is enough?

@LecrisUT
Copy link
Copy Markdown
Collaborator Author

LecrisUT commented Oct 30, 2023

LGTM for the contents.
I am not sure about the frequency of pre-releases in sphinx-book-theme, but it may be better to wait before we merge this PR?

I think we should go forward with this to get the changelog format in and then build upon it. Then, before making an spglib release, we just revert 16a1efd when upstream sphinx-book-theme has made a release. It should happen soon given the pressure on that package

@LecrisUT LecrisUT assigned lan496 and unassigned LecrisUT Oct 30, 2023
@lan496
Copy link
Copy Markdown
Member

lan496 commented Oct 30, 2023

I see. Then, I proceed to merge.

@lan496 lan496 merged commit 9f53cb9 into spglib:develop Oct 30, 2023
@Porkepix Porkepix mentioned this pull request Dec 8, 2023
Merged
@LecrisUT LecrisUT deleted the changelog branch January 25, 2024 10:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@lan496 lan496 lan496 approved these changes

Assignees

@lan496 lan496

Labels

documentation

Projects

Spglib developers' kanban
Status: ✅ Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@LecrisUT @codecov-commenter @lan496