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

📚 DOCS: Use sphinx-autodoc2 for API #704

Merged
merged 4 commits into from Feb 19, 2023
Merged

Conversation

chrisjsewell
Copy link
Member

@chrisjsewell chrisjsewell commented Feb 19, 2023

This will allow moving source docstrings to use MyST instead of rST 🎉

@codecov
Copy link

codecov bot commented Feb 19, 2023

Codecov Report

Base: 89.62% // Head: 89.62% // No change to project coverage 👍

Coverage data is based on head (ed9e64e) compared to base (cce4684).
Patch coverage: 66.66% of modified lines in pull request are covered.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #704   +/-   ##
=======================================
  Coverage   89.62%   89.62%           
=======================================
  Files          22       22           
  Lines        2717     2717           
=======================================
  Hits         2435     2435           
  Misses        282      282           
Flag Coverage Δ
pytests 89.62% <66.66%> (ø)

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

Impacted Files Coverage Δ
myst_parser/docutils_.py 100.00% <ø> (ø)
myst_parser/inventory.py 82.78% <ø> (ø)
myst_parser/mdit_to_docutils/base.py 92.69% <0.00%> (ø)
myst_parser/sphinx_.py 100.00% <ø> (ø)
myst_parser/config/dc_validators.py 83.63% <100.00%> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

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

@chrisjsewell chrisjsewell merged commit fc59f3b into master Feb 19, 2023
@chrisjsewell chrisjsewell deleted the sphinx-autodoc2 branch February 19, 2023 19:50
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

1 participant