Skip to content

Fix quick for autodoc2 render plugin#391

Merged
lan496 merged 1 commit intospglib:developfrom
lan496:fix-autodoc2-render
Jan 10, 2024
Merged

Fix quick for autodoc2 render plugin#391
lan496 merged 1 commit intospglib:developfrom
lan496:fix-autodoc2-render

Conversation

@lan496
Copy link
Copy Markdown
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
Copy Markdown

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
Copy Markdown
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
@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.

3 participants