-
Notifications
You must be signed in to change notification settings - Fork 321
Update sphinx to use new sphinx.ext.apidoc extension #3068
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
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #3068 +/- ##
==========================================
- Coverage 96.14% 96.11% -0.04%
==========================================
Files 383 383
Lines 55785 55685 -100
==========================================
- Hits 53636 53523 -113
- Misses 2149 2162 +13
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Saves on memory usage and overall execution time for documentation that very few would use
|
I'm not pleased with one thing I see so far in the docs. The "Satpy API" link on the home page says "satpy package". I think Sphinx is getting confused because for some reason the new |
|
When sphinx-doc/sphinx#13391 is merged and released it will fix the API title issue I mentioned in my previous comment. |
mraspaud
left a comment
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.
Thanks for sorting this out! I’m totally fine with not building documentation for the tests.
LGTM.
Updates sphinx to 8.2 which adds a sphinx.ext.apidoc extension and replaces sphinxcontrib.apidoc. I also turned off documenting most test modules which cuts off ~30 seconds (50%) of execution time and ~2GB of memory usage (80%).
AUTHORS.mdif not there already