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
Conversation
Codecov Report
@@ 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
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
DeepCode failed to analyze this pull requestSomething went wrong despite trying multiple times, sorry about that. |
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. |
There was a problem hiding this 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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why?
There was a problem hiding this comment.
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).
There was a problem hiding this comment.
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.
Are we running doctests on satpy btw? |
We are not and I'm not sure they are set up to be doctested (using non-existent paths, etc). |
Awesome, thanks! |
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.