Improve release documentaiton #257

LecrisUT · 2023-03-03T17:32:19Z

Adapted Keep-a-changelog format

codecov-commenter · 2023-03-03T17:54:46Z

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 · 2023-03-03T17:58:15Z

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

lan496 · 2023-06-17T14:25:08Z

@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 · 2023-06-17T15:07:30Z

@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 · 2023-06-17T21:00:54Z

@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 :()

lan496 · 2023-06-18T11:00:08Z

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

LecrisUT · 2023-06-18T13:29:16Z

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.

Signed-off-by: Cristian Le <cristian.le@mpsd.mpg.de>

Signed-off-by: Cristian Le <git@lecris.dev>

Fixes bib reference issue Signed-off-by: Cristian Le <git@lecris.dev> Signed-off-by: Cristian Le <cristian.le@mpsd.mpg.de> Signed-off-by: Cristian Le <git@lecris.dev>

Signed-off-by: Cristian Le <git@lecris.dev>

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 <git@lecris.dev>

lan496

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?

lan496 · 2023-04-07T11:25:35Z

doc/README.md

-Python>=3.8 required for `importlib.metadata`.
+```shell
+$ pip install ".[docs]"
+$ python3 scripts/generate_changelog.py --type local


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

LecrisUT · 2023-10-30T09:19:10Z

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

lan496 · 2023-10-30T09:48:42Z

I see. Then, I proceed to merge.

LecrisUT force-pushed the changelog branch 2 times, most recently from ff83c5f to 176f3fb Compare March 3, 2023 17:47

LecrisUT added the documentation label Mar 3, 2023

LecrisUT mentioned this pull request Mar 3, 2023

Include an autoreleaser #254

Merged

LecrisUT mentioned this pull request Mar 4, 2023

Change SPGCONST to const #258

Merged

LecrisUT force-pushed the changelog branch from ad33908 to 8628c09 Compare March 6, 2023 15:30

LecrisUT force-pushed the changelog branch from 8628c09 to 5a9c578 Compare April 5, 2023 07:31

LecrisUT requested a review from lan496 April 6, 2023 14:28

LecrisUT force-pushed the changelog branch from 03513e8 to e11c4aa Compare April 13, 2023 13:05

LecrisUT self-assigned this Jun 17, 2023

LecrisUT force-pushed the changelog branch 2 times, most recently from 688fddc to 7b40377 Compare June 17, 2023 21:06

LecrisUT marked this pull request as draft June 17, 2023 21:08

LecrisUT force-pushed the changelog branch 2 times, most recently from 398a846 to 41dbc70 Compare June 19, 2023 13:55

LecrisUT mentioned this pull request Jun 20, 2023

Synchronize content of README.md to index.md page #305

Open

LecrisUT force-pushed the changelog branch from 41dbc70 to 26f07bf Compare June 20, 2023 12:50

LecrisUT force-pushed the changelog branch from 26f07bf to 3bc4b87 Compare June 30, 2023 12:30

lan496 mentioned this pull request Sep 6, 2023

Add citation info #322

Merged

LecrisUT mentioned this pull request Oct 28, 2023

Releasing v2.2.0 #350

Closed

2 tasks

LecrisUT and others added 3 commits October 29, 2023 19:32

Move Changelog to Changelog.md

47e784f

Signed-off-by: Cristian Le <cristian.le@mpsd.mpg.de>

Use keepachangelog format

dd1072e

Signed-off-by: Cristian Le <cristian.le@mpsd.mpg.de>

Move changelog content from release.md

4f19425

Signed-off-by: Cristian Le <git@lecris.dev>

LecrisUT and others added 3 commits October 29, 2023 19:46

Reformat ChangeLog.md

e714669

Signed-off-by: Cristian Le <git@lecris.dev>

Bump sphinx, bibtex and myst-parser

c470790

Fixes bib reference issue Signed-off-by: Cristian Le <git@lecris.dev> Signed-off-by: Cristian Le <cristian.le@mpsd.mpg.de> Signed-off-by: Cristian Le <git@lecris.dev>

Simplify conf.py

c438104

Signed-off-by: Cristian Le <git@lecris.dev>

LecrisUT force-pushed the changelog branch from 3bc4b87 to c438104 Compare October 29, 2023 19:12

LecrisUT marked this pull request as ready for review October 29, 2023 19:13

[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 <git@lecris.dev>

lan496 approved these changes Oct 30, 2023

View reviewed changes

LecrisUT assigned lan496 and unassigned LecrisUT Oct 30, 2023

lan496 merged commit 9f53cb9 into spglib:develop Oct 30, 2023
43 of 49 checks passed

Porkepix mentioned this pull request Dec 8, 2023

spglib 2.2.0 Homebrew/homebrew-core#156751

Merged

LecrisUT deleted the changelog branch January 25, 2024 10:43

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve release documentaiton #257

Improve release documentaiton #257

LecrisUT commented Mar 3, 2023 •

edited

codecov-commenter commented Mar 3, 2023 •

edited

LecrisUT commented Mar 3, 2023 •

edited

lan496 commented Jun 17, 2023

LecrisUT commented Jun 17, 2023

LecrisUT commented Jun 17, 2023 •

edited

lan496 commented Jun 18, 2023

LecrisUT commented Jun 18, 2023

lan496 left a comment

lan496 Apr 7, 2023

LecrisUT commented Oct 30, 2023

lan496 commented Oct 30, 2023

Improve release documentaiton #257

Improve release documentaiton #257

Conversation

LecrisUT commented Mar 3, 2023 • edited

codecov-commenter commented Mar 3, 2023 • edited

Codecov Report

LecrisUT commented Mar 3, 2023 • edited

lan496 commented Jun 17, 2023

LecrisUT commented Jun 17, 2023

LecrisUT commented Jun 17, 2023 • edited

lan496 commented Jun 18, 2023

LecrisUT commented Jun 18, 2023

lan496 left a comment

Choose a reason for hiding this comment

lan496 Apr 7, 2023

Choose a reason for hiding this comment

LecrisUT commented Oct 30, 2023

lan496 commented Oct 30, 2023

LecrisUT commented Mar 3, 2023 •

edited

codecov-commenter commented Mar 3, 2023 •

edited

LecrisUT commented Mar 3, 2023 •

edited

LecrisUT commented Jun 17, 2023 •

edited