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

Switch to sphinxcontrib.apidoc for automatically updating API docs #1543

Merged
merged 9 commits into from Feb 11, 2021

Conversation

djhoese
Copy link
Member

@djhoese djhoese commented Feb 10, 2021

As mentioned in #1540, this adds sphinxcontrib.apidoc to your sphinx documentation generation so it automatically reloads the satpy api and has up to date modules/structure.

@codecov
Copy link

codecov bot commented Feb 10, 2021

Codecov Report

Merging #1543 (4a6adb8) into master (ae77ccd) will decrease coverage by 1.14%.
The diff coverage is 83.33%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #1543      +/-   ##
==========================================
- Coverage   92.02%   90.88%   -1.15%     
==========================================
  Files         249      249              
  Lines       36325    36334       +9     
==========================================
- Hits        33429    33022     -407     
- Misses       2896     3312     +416     
Flag Coverage Δ
behaviourtests 4.35% <13.33%> (+<0.01%) ⬆️
unittests 91.41% <83.33%> (-1.16%) ⬇️

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

Impacted Files Coverage Δ
satpy/readers/ahi_l1b_gridded_bin.py 99.05% <ø> (ø)
satpy/readers/fci_l2_nc.py 92.80% <ø> (ø)
satpy/readers/goes_imager_nc.py 65.46% <0.00%> (ø)
satpy/readers/iasi_l2_so2_bufr.py 25.80% <ø> (-68.82%) ⬇️
satpy/readers/mimic_TPW2_nc.py 80.95% <ø> (ø)
satpy/readers/nucaps.py 89.14% <ø> (-0.05%) ⬇️
satpy/readers/nwcsaf_nc.py 60.40% <0.00%> (ø)
satpy/readers/olci_nc.py 91.42% <0.00%> (ø)
satpy/readers/scmi.py 82.91% <0.00%> (ø)
satpy/tests/reader_tests/test_ahi_hsd.py 100.00% <ø> (ø)
... and 35 more

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 ae77ccd...f8e89f5. Read the comment docs.

@djhoese djhoese mentioned this pull request Feb 10, 2021
2 tasks
@ghost
Copy link

ghost commented Feb 10, 2021

DeepCode failed to analyze this pull request

Something went wrong despite trying multiple times, sorry about that.
Please comment this pull request with "Retry DeepCode" to manually retry, or contact us so that a human can look into the issue.

@djhoese
Copy link
Member Author

djhoese commented Feb 10, 2021

It is done! The website and linting complete with no errors...I hope. Tests do not run on github unless linting passes. The website is executed and if there are any warnings they are raised as an error.

Copy link
Member

@mraspaud mraspaud left a comment

Choose a reason for hiding this comment

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

LGTM, just one inline question

@@ -15,3 +15,6 @@ universal=1
max-line-length = 120
exclude =
satpy/readers/li_l2.py
satpy/readers/scatsat1_l2b.py
Copy link
Member

Choose a reason for hiding this comment

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

Why?

Copy link
Member Author

@djhoese djhoese Feb 11, 2021

Choose a reason for hiding this comment

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

This is an old reader that hasn't been updated to use xarray yet and has a lot of style issues (same for li_l2.py and the others).

Copy link
Member Author

Choose a reason for hiding this comment

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

To clarify more, these modules use the deprecated Dataset import. To fully fix the styling in them I would have to update them to use xarray as flake8 (with all the various plugins we use) will likely complain about things in some way.

@mraspaud
Copy link
Member

Are we running doctests on satpy btw?

@djhoese
Copy link
Member Author

djhoese commented Feb 11, 2021

We are not and I'm not sure they are set up to be doctested (using non-existent paths, etc).

@sfinkens
Copy link
Member

Awesome, thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants