Skip to content

Conversation

@djhoese
Copy link
Member

@djhoese djhoese commented Feb 19, 2025

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%).

  • Closes #xxxx
  • Tests added
  • Fully documented
  • Add your name to AUTHORS.md if not there already

@djhoese djhoese added the cleanup Code cleanup but otherwise no change in functionality label Feb 19, 2025
@djhoese djhoese self-assigned this Feb 19, 2025
@djhoese djhoese requested a review from mraspaud as a code owner February 19, 2025 19:12
@codecov
Copy link

codecov bot commented Feb 19, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.11%. Comparing base (17cf0ce) to head (9b43c72).
Report is 472 commits behind head on main.

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     
Flag Coverage Δ
behaviourtests 3.88% <ø> (+<0.01%) ⬆️
unittests 96.21% <ø> (-0.04%) ⬇️

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@djhoese
Copy link
Member Author

djhoese commented Feb 24, 2025

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 api/modules.rst file doesn't have a title and it is ignoring our forced title in index.rst.

@djhoese
Copy link
Member Author

djhoese commented Feb 25, 2025

When sphinx-doc/sphinx#13391 is merged and released it will fix the API title issue I mentioned in my previous comment.

@djhoese djhoese changed the title Fix deprecated codecov action parameter use Update sphinx to use new sphinx.ext.apidoc extension Feb 25, 2025
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.

Thanks for sorting this out! I’m totally fine with not building documentation for the tests.
LGTM.

@pnuu pnuu merged commit a950fcc into pytroll:main Mar 3, 2025
17 of 18 checks passed
@djhoese djhoese deleted the ci-workflow-warns branch March 3, 2025 13:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cleanup Code cleanup but otherwise no change in functionality documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants