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

Doc fixes #1648

Merged
merged 7 commits into from
Aug 15, 2023
Merged

Doc fixes #1648

merged 7 commits into from
Aug 15, 2023

Conversation

kbwestfall
Copy link
Collaborator

Fixes warnings in the doc compilation that actually cause the ReadTheDocs build to fail.

Most of these changes are an artifact of me trying to find the failures. The bottom line is that warnings were being caused by syntax like this:

:class:`~pypeit.alignframe.AlignmentSplines`_

This is a mix of an explicit hyperlink that requires the _ at the end, and an internal class reference, which does not. The solution is to remove the trailing _.

This also includes updates to the Sphinx version dependencies, and I now include scikit-image and specutils in the dev dependencies.

@codecov-commenter
Copy link

codecov-commenter commented Aug 9, 2023

Codecov Report

Merging #1648 (270f886) into develop (2c8fcaa) will not change coverage.
The diff coverage is 100.00%.

❗ 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.

@@           Coverage Diff            @@
##           develop    #1648   +/-   ##
========================================
  Coverage    41.03%   41.03%           
========================================
  Files          189      189           
  Lines        43221    43221           
========================================
  Hits         17736    17736           
  Misses       25485    25485           
Files Changed Coverage Δ
pypeit/bitmask.py 71.42% <ø> (ø)
pypeit/core/arc.py 43.56% <ø> (ø)
pypeit/core/collate.py 95.71% <ø> (ø)
pypeit/core/extract.py 77.16% <ø> (ø)
pypeit/core/findobj_skymask.py 24.77% <ø> (ø)
pypeit/core/flexure.py 45.82% <ø> (ø)
pypeit/core/flux_calib.py 64.06% <ø> (ø)
pypeit/core/gui/object_find.py 11.06% <ø> (ø)
pypeit/core/skysub.py 61.81% <ø> (ø)
pypeit/core/wavecal/autoid.py 26.36% <ø> (ø)
... and 10 more

Copy link
Collaborator

@profxj profxj left a comment

Choose a reason for hiding this comment

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

Thanks for this major clean up!

@profxj profxj requested a review from debora-pe August 13, 2023 13:36
Copy link
Collaborator

@debora-pe debora-pe left a comment

Choose a reason for hiding this comment

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

Thank you so much for this!!!

@kbwestfall kbwestfall merged commit 053816d into develop Aug 15, 2023
25 checks passed
@kbwestfall kbwestfall deleted the docfix branch August 15, 2023 20:15
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.

4 participants