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

Silence docs build warnings #174

Merged
merged 4 commits into from
Jan 12, 2022
Merged

Silence docs build warnings #174

merged 4 commits into from
Jan 12, 2022

Conversation

bwohlberg
Copy link
Collaborator

Silence docs build warnings discussed in #167. As a side effect (the desirability of which is perhaps worthy of discussion), disables documentation of inherited methods in scico.jax classes. In addition, the version pinning of sphinx-autodoc-typehints introduced in #171 is no longer necessary (also worth discussing whether this pinning should now be removed).

@bwohlberg bwohlberg added the documentation Improvements or additions to documentation label Jan 12, 2022
@bwohlberg bwohlberg linked an issue Jan 12, 2022 that may be closed by this pull request
@codecov
Copy link

codecov bot commented Jan 12, 2022

Codecov Report

Merging #174 (ef5ff95) into main (c6cf603) will increase coverage by 0.00%.
The diff coverage is 100.00%.

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #174   +/-   ##
=======================================
  Coverage   92.13%   92.14%           
=======================================
  Files          48       48           
  Lines        3295     3298    +3     
=======================================
+ Hits         3036     3039    +3     
  Misses        259      259           
Flag Coverage Δ
unittests 92.14% <100.00%> (+<0.01%) ⬆️

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

Impacted Files Coverage Δ
scico/flax.py 100.00% <100.00%> (ø)

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 c6cf603...ef5ff95. Read the comment docs.

Copy link
Contributor

@Michael-T-McCann Michael-T-McCann left a comment

Choose a reason for hiding this comment

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

("disables documentation of inherited methods in scico.jax classes" I suspect that should read "scico.flax".)

I had a look at the effect on the docs and prefer it to what we had before.

@bwohlberg
Copy link
Collaborator Author

Yes, correct, I meant scico.flax.

@bwohlberg bwohlberg merged commit e68cda4 into main Jan 12, 2022
@bwohlberg bwohlberg deleted the brendt/docs-warnings branch January 12, 2022 20:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Warnings during docs build
2 participants