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

DM-39832: Clean up sphinx docs #59

Merged
merged 8 commits into from Jun 29, 2023
Merged

DM-39832: Clean up sphinx docs #59

merged 8 commits into from Jun 29, 2023

Conversation

timj
Copy link
Member

@timj timj commented Jun 29, 2023

Checklist

  • ran Jenkins
  • added a release note for user-visible changes to doc/changes

@codecov
Copy link

codecov bot commented Jun 29, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (fc13523) 85.61% compared to head (da85b31) 85.61%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #59   +/-   ##
=======================================
  Coverage   85.61%   85.61%           
=======================================
  Files          27       27           
  Lines        3949     3949           
  Branches      818      818           
=======================================
  Hits         3381     3381           
  Misses        441      441           
  Partials      127      127           
Impacted Files Coverage Δ
.../resources/_resourceHandles/_baseResourceHandle.py 78.72% <ø> (ø)
.../resources/_resourceHandles/_fileResourceHandle.py 79.24% <ø> (ø)
.../resources/_resourceHandles/_httpResourceHandle.py 72.41% <ø> (ø)
...st/resources/_resourceHandles/_s3ResourceHandle.py 80.62% <ø> (ø)
python/lsst/resources/_resourcePath.py 95.86% <ø> (ø)
python/lsst/resources/utils.py 62.26% <ø> (ø)

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

@timj timj marked this pull request as ready for review June 29, 2023 19:17
doc/lsst.resources/index.rst Outdated Show resolved Hide resolved
@@ -38,10 +38,10 @@ class CloseStatus(Enum):

class ResourceHandleProtocol(Protocol, Generic[U]):
"""Defines the interface protocol that is compatible with children of
`BaseResourceHandle`.
`.BaseResourceHandle`.
Copy link
Member

@TallJimbo TallJimbo Jun 29, 2023

Choose a reason for hiding this comment

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

<rant>
Ugh, I see so much of this in our future. I really wish Sphinx could just look at how we've imported symbols! </rant>

python/lsst/resources/_resourcePath.py Outdated Show resolved Hide resolved
@timj timj merged commit 098d5bd into main Jun 29, 2023
14 checks passed
@timj timj deleted the tickets/DM-39832 branch June 29, 2023 21:27
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

2 participants