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-32801: Add sphinx docs build action #109

Merged
merged 6 commits into from Dec 4, 2021
Merged

DM-32801: Add sphinx docs build action #109

merged 6 commits into from Dec 4, 2021

Conversation

timj
Copy link
Member

@timj timj commented Dec 3, 2021

Checklist

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

@codecov
Copy link

codecov bot commented Dec 3, 2021

Codecov Report

Merging #109 (9ba4fc8) into main (e1fd236) will increase coverage by 0.00%.
The diff coverage is 100.00%.

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #109   +/-   ##
=======================================
  Coverage   91.27%   91.28%           
=======================================
  Files          36       36           
  Lines        2154     2156    +2     
=======================================
+ Hits         1966     1968    +2     
  Misses        188      188           
Impacted Files Coverage Δ
python/lsst/utils/_forwarded.py 75.00% <ø> (ø)
python/lsst/utils/inheritDoc.py 27.27% <ø> (ø)
python/lsst/utils/logging.py 81.55% <ø> (ø)
python/lsst/utils/tests.py 74.68% <ø> (ø)
python/lsst/utils/timer.py 96.26% <ø> (ø)
python/lsst/utils/__init__.py 100.00% <100.00%> (ø)
python/lsst/utils/backtrace/__init__.py 83.33% <100.00%> (+1.51%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e1fd236...9ba4fc8. Read the comment docs.

@timj timj requested a review from ktlim December 3, 2021 19:49
This lets mypy find the type annotations.
Copy link
Contributor

@ktlim ktlim left a comment

Choose a reason for hiding this comment

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

I'm a little worried about all of the style/lint changes going on informally without a clear roadmap or policy, but this looks OK.

@timj timj merged commit 7409401 into main Dec 4, 2021
@timj timj deleted the tickets/DM-32801 branch December 4, 2021 03:47
@timj
Copy link
Member Author

timj commented Dec 6, 2021

Most of the fixes here are fixing legitimate problems with the numpydoc so I'm not sure what the problem is.

@ktlim
Copy link
Contributor

ktlim commented Dec 6, 2021

pydocstyle has not been formally adopted (and barely even suggested, to my knowledge) as a tool for checking/verifying our docs. I agree that it can help us get rid of a lot of warnings and other problems, but we still shouldn't add it in random places without a clear roadmap.

@timj
Copy link
Member Author

timj commented Dec 6, 2021

Right, but the usage here is consistent with the dev guide isn't it? What we haven't done is formalized the list of warnings that should be used -- the ones here and in daf_butler are adhoc.

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