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

Fix quick for autodoc2 render plugin #391

Merged
merged 1 commit into from Jan 10, 2024

Conversation

lan496
Copy link
Member

@lan496 lan496 commented Jan 10, 2024

After merging #387, I have noticed auto summaries are generated in reStructuredText, not compatible with other myst documents.
https://spglib.readthedocs.io/en/latest/python-interface.html#version

This PR uses myst as autodoc2 render plugin and uses reStructuredText only for docstrings.

@lan496 lan496 requested a review from LecrisUT January 10, 2024 03:27
@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (50a2c3f) 83.86% compared to head (fc11efe) 83.86%.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop     #391   +/-   ##
========================================
  Coverage    83.86%   83.86%           
========================================
  Files           24       24           
  Lines         8180     8180           
========================================
  Hits          6860     6860           
  Misses        1320     1320           
Flag Coverage Δ
c_api 77.59% <ø> (ø)
fortran_api 56.15% <ø> (ø)
python_api 80.38% <ø> (ø)
unit_tests 1.24% <ø> (ø)

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

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

Copy link
Collaborator

@LecrisUT LecrisUT left a comment

Choose a reason for hiding this comment

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

Weird, I wouldn't have expected it to affect that

@lan496 lan496 merged commit ba444f4 into spglib:develop Jan 10, 2024
35 of 45 checks passed
@lan496 lan496 deleted the fix-autodoc2-render branch January 10, 2024 07:36
@lan496 lan496 added this to the 2.3 milestone Jan 27, 2024
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.

None yet

3 participants