-
Notifications
You must be signed in to change notification settings - Fork 171
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
JP-3471 improve Step.spec attribute formating in docs #8101
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #8101 +/- ##
=======================================
Coverage 75.92% 75.93%
=======================================
Files 459 459
Lines 37615 37616 +1
=======================================
+ Hits 28561 28562 +1
Misses 9054 9054
*This pull request uses carry forward flags. Click here to find out more. ☔ View full report in Codecov by Sentry. |
this allows for improved Step.spec formatting and makes the auto-generated docs more consistent
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh wow! I am impressed!
Wow, the docs now look great! Nice job. But what's causing all the CI tests to fail in the jwst/tweakreg/tests/test_amutils.py test module? |
Thanks for pointing that out! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
OK, looks good now.
Resolves JP-3471
Closes #8085
This PR adds a custom
AttributeDocumenter
subclass to control the formatting of the longStep.spec
string in the sphinx documentation.For one example see the OutlierDetectionStep spec:
https://jwst-pipeline.readthedocs.io/en/latest/api/jwst.outlier_detection.OutlierDetectionStep.html#jwst.outlier_detection.OutlierDetectionStep.spec
and with this PR:
https://jwst-pipeline--8101.org.readthedocs.build/en/8101/api/jwst.outlier_detection.OutlierDetectionStep.html#jwst.outlier_detection.OutlierDetectionStep.spec
To update the formatting outside of
api
a few uses ofautomodule
are replaced withautomodapi
:One change to the code was necessary (adding an
__all__
tojwst/tweakreg/astrometric_utils.py
to allowautomodapi
to pick up the documentation forTIMEOUT
see: https://jwst-pipeline--8101.org.readthedocs.build/en/8101/jwst/tweakreg/astrometric_utils.html#variables).Checklist for maintainers
CHANGES.rst
within the relevant release sectionHow to run regression tests on a PR