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

Sphinx autodoc configuration changes #260

Merged
merged 4 commits into from
Mar 23, 2022
Merged

Sphinx autodoc configuration changes #260

merged 4 commits into from
Mar 23, 2022

Conversation

bwohlberg
Copy link
Collaborator

Disable inclusion of inherited members in sphinx autodoc. Also address some sphinx warnings and style issues.

@bwohlberg bwohlberg added the documentation Improvements or additions to documentation label Mar 23, 2022
@codecov
Copy link

codecov bot commented Mar 23, 2022

Codecov Report

Merging #260 (991c8a0) into main (ec37e48) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #260   +/-   ##
=======================================
  Coverage   93.61%   93.61%           
=======================================
  Files          49       49           
  Lines        3541     3541           
=======================================
  Hits         3315     3315           
  Misses        226      226           
Flag Coverage Δ
unittests 93.61% <ø> (ø)

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

Impacted Files Coverage Δ
scico/linop/_linop.py 98.07% <ø> (ø)
scico/linop/optics.py 95.68% <ø> (ø)

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 ec37e48...991c8a0. 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.

Copy link
Contributor

@crstngc crstngc left a comment

Choose a reason for hiding this comment

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

I agree. This is a nice change that reduces the clutter in the documentation.

@bwohlberg bwohlberg merged commit 1c71bca into main Mar 23, 2022
@bwohlberg bwohlberg deleted the brendt/docs branch March 23, 2022 23:40
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.

3 participants