Skip to content

Clean up and documentation fix #246

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 10 commits into from
Jun 19, 2023
Merged

Clean up and documentation fix #246

merged 10 commits into from
Jun 19, 2023

Conversation

LecrisUT
Copy link
Collaborator

@LecrisUT LecrisUT commented Feb 23, 2023 •
edited
Loading

Mostly cleaning up some old files and fixing the documentation about python installation.

Depends on: #241

Closes: #244
Closes: #240

@LecrisUT LecrisUT added this to the 2.1 milestone Feb 23, 2023
@codecov-commenter
Copy link

codecov-commenter commented Feb 24, 2023 •
edited
Loading

Codecov Report

Patch and project coverage have no change.

Comparison is base (d6fcbe8) 86.09% compared to head (8a5993b) 86.09%.

❗ Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more.

Additional details and impacted files 
@@           Coverage Diff            @@
##           develop     #246   +/-   ##
========================================
  Coverage    86.09%   86.09%           
========================================
  Files           23       23           
  Lines         6069     6069           
========================================
  Hits          5225     5225           
  Misses         844      844
Flag Coverage Δ
c_api 76.50% <ø> (ø)
fortran_api 37.46% <ø> (ø)
python_api 82.83% <ø> (ø)

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

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

lan496
lan496 reviewed Feb 25, 2023
View reviewed changes
lan496
lan496 reviewed Feb 25, 2023
View reviewed changes
lan496
lan496 reviewed Feb 25, 2023
View reviewed changes
@LecrisUT LecrisUT force-pushed the clean-up branch 4 times, most recently from 9f9a749 to ca921aa Compare February 27, 2023 14:51
@LecrisUT
Copy link
Collaborator Author

LecrisUT commented Feb 27, 2023 •
edited
Loading

It seems when I rebased, I have undone some fixes from mdformat. We cannot run mdformat to redo them, but hopefully we can catch and redo them if necessary. We got mdformat back on docs.

@lan496
Copy link
Member

lan496 commented Jun 17, 2023

@LecrisUT Can you rebase and leave the ruby interface? Let's discuss the deprecation or support for the ruby interface for another issue.

@lan496 lan496 mentioned this pull request Jun 17, 2023
Open
@LecrisUT LecrisUT self-assigned this Jun 17, 2023
LecrisUT added 10 commits June 17, 2023 22:47
@LecrisUT
Cleanup old files
b192dea 
Signed-off-by: Cristian Le <cristian.le@mpsd.mpg.de>
@LecrisUT
Remove some outdated documentations
5d8acc8 
Signed-off-by: Cristian Le <cristian.le@mpsd.mpg.de>
Signed-off-by: Cristian Le <git@lecris.dev>
@LecrisUT
Edit the python installation documentation
c738b78 
Signed-off-by: Cristian Le <cristian.le@mpsd.mpg.de>
@LecrisUT
Chore: Change sphinx math syntax to latex style dollarmath
28a4409 
Signed-off-by: Cristian Le <cristian.le@mpsd.mpg.de>
@LecrisUT
Fix dollarmath labels
1d52b28 
Signed-off-by: Cristian Le <cristian.le@mpsd.mpg.de>
@LecrisUT
Autogenerate heading labels
795a17e 
Signed-off-by: Cristian Le <cristian.le@mpsd.mpg.de>
@LecrisUT
Fix missrendered equation
7fc80b7 
Signed-off-by: Cristian Le <cristian.le@mpsd.mpg.de>
@LecrisUT
Revert double-tick change
105db40 
Signed-off-by: Cristian Le <cristian.le@mpsd.mpg.de>
@LecrisUT
Add mdformat to docs/*
2d8ebab 
Signed-off-by: Cristian Le <cristian.le@mpsd.mpg.de>
@LecrisUT
Run mdformat on docs
8a5993b 
Signed-off-by: Cristian Le <cristian.le@mpsd.mpg.de>
@LecrisUT LecrisUT removed their assignment Jun 17, 2023
@LecrisUT LecrisUT mentioned this pull request Jun 17, 2023
Merged
@lan496 lan496 requested a review from atztogo June 18, 2023 10:53
@lan496
Copy link
Member

lan496 commented Jun 18, 2023

@atztogo Can you check the revised documents, especially doc/python-spglib.md? I think it looks good, but I would like to confirm because this file is largely changed.

atztogo
atztogo approved these changes Jun 19, 2023
View reviewed changes
Copy link
Collaborator

@atztogo atztogo left a comment

Choose a reason for hiding this comment

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

For me perfect. #299 may be considered, but no problem to publish as it is. Thanks @LecrisUT and @lan496 for your great work.

@LecrisUT LecrisUT merged commit fdcaafc into spglib:develop Jun 19, 2023
@LecrisUT LecrisUT deleted the clean-up branch June 19, 2023 09:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lan496 lan496 lan496 left review comments

@atztogo atztogo atztogo approved these changes

Assignees

@lan496 lan496

Labels
documentation
Projects
Spglib developers' kanban
Status: ✅ Done
Milestone
2.1
Development

Successfully merging this pull request may close these issues.

Clen up repo Outdated documentation
4 participants
@LecrisUT @codecov-commenter @lan496 @atztogo