Skip to content

use canonical filename of RTD configuration, enable nitpicky mode, and build with Python 3.13 and Sphinx 9#24

Merged
zacharyburnett merged 5 commits into
spacetelescope:masterfrom
zacharyburnett:rtd_update
Feb 2, 2026
Merged

use canonical filename of RTD configuration, enable nitpicky mode, and build with Python 3.13 and Sphinx 9#24
zacharyburnett merged 5 commits into
spacetelescope:masterfrom
zacharyburnett:rtd_update

Conversation

@zacharyburnett
Copy link
Copy Markdown
Collaborator

@zacharyburnett zacharyburnett commented Sep 20, 2022

change .readthedocs.yml -> .readthedocs.yaml, enable nitpicky to validate intra-doc links, and enable fail_on_warning

@zacharyburnett
Copy link
Copy Markdown
Collaborator Author

errors https://readthedocs.org/projects/costools/builds/18124535/:

/home/docs/checkouts/readthedocs.org/user_builds/costools/checkouts/24/costools/timefilter.py:docstring of costools.timefilter.TimelineFilter:77: WARNING: autosummary: stub file not found 'costools.timefilter.TimelineFilter.clearDqFlag'. Check your autosummary_generate setting.
/home/docs/checkouts/readthedocs.org/user_builds/costools/checkouts/24/costools/timefilter.py:docstring of costools.timefilter.TimelineFilter:77: WARNING: autosummary: stub file not found 'costools.timefilter.TimelineFilter.findExtensions'. Check your autosummary_generate setting.
/home/docs/checkouts/readthedocs.org/user_builds/costools/checkouts/24/costools/timefilter.py:docstring of costools.timefilter.TimelineFilter:77: WARNING: autosummary: stub file not found 'costools.timefilter.TimelineFilter.findHduNum'. Check your autosummary_generate setting.
/home/docs/checkouts/readthedocs.org/user_builds/costools/checkouts/24/costools/timefilter.py:docstring of costools.timefilter.TimelineFilter:77: WARNING: autosummary: stub file not found 'costools.timefilter.TimelineFilter.getFirstGTI'. Check your autosummary_generate setting.
/home/docs/checkouts/readthedocs.org/user_builds/costools/checkouts/24/costools/timefilter.py:docstring of costools.timefilter.TimelineFilter:77: WARNING: autosummary: stub file not found 'costools.timefilter.TimelineFilter.interpretFilter'. Check your autosummary_generate setting.
/home/docs/checkouts/readthedocs.org/user_builds/costools/checkouts/24/costools/timefilter.py:docstring of costools.timefilter.TimelineFilter:77: WARNING: autosummary: stub file not found 'costools.timefilter.TimelineFilter.mergeGTI'. Check your autosummary_generate setting.
/home/docs/checkouts/readthedocs.org/user_builds/costools/checkouts/24/costools/timefilter.py:docstring of costools.timefilter.TimelineFilter:77: WARNING: autosummary: stub file not found 'costools.timefilter.TimelineFilter.printInfo'. Check your autosummary_generate setting.
/home/docs/checkouts/readthedocs.org/user_builds/costools/checkouts/24/costools/timefilter.py:docstring of costools.timefilter.TimelineFilter:77: WARNING: autosummary: stub file not found 'costools.timefilter.TimelineFilter.recomputeExptime'. Check your autosummary_generate setting.
/home/docs/checkouts/readthedocs.org/user_builds/costools/checkouts/24/costools/timefilter.py:docstring of costools.timefilter.TimelineFilter:77: WARNING: autosummary: stub file not found 'costools.timefilter.TimelineFilter.roundGTI'. Check your autosummary_generate setting.
/home/docs/checkouts/readthedocs.org/user_builds/costools/checkouts/24/costools/timefilter.py:docstring of costools.timefilter.TimelineFilter:77: WARNING: autosummary: stub file not found 'costools.timefilter.TimelineFilter.saaFilter'. Check your autosummary_generate setting.
/home/docs/checkouts/readthedocs.org/user_builds/costools/checkouts/24/costools/timefilter.py:docstring of costools.timefilter.TimelineFilter:77: WARNING: autosummary: stub file not found 'costools.timefilter.TimelineFilter.saveNewGTI'. Check your autosummary_generate setting.
/home/docs/checkouts/readthedocs.org/user_builds/costools/checkouts/24/costools/timefilter.py:docstring of costools.timefilter.TimelineFilter:77: WARNING: autosummary: stub file not found 'costools.timefilter.TimelineFilter.setDqFlag'. Check your autosummary_generate setting.
/home/docs/checkouts/readthedocs.org/user_builds/costools/checkouts/24/costools/timefilter.py:docstring of costools.timefilter.TimelineFilter:77: WARNING: autosummary: stub file not found 'costools.timefilter.TimelineFilter.shift1Info'. Check your autosummary_generate setting.
/home/docs/checkouts/readthedocs.org/user_builds/costools/checkouts/24/costools/timefilter.py:docstring of costools.timefilter.TimelineFilter:77: WARNING: autosummary: stub file not found 'costools.timefilter.TimelineFilter.writeNewOutputFile'. Check your autosummary_generate setting.

@zacharyburnett zacharyburnett requested a review from a team as a code owner September 13, 2023 15:04
@codecov
Copy link
Copy Markdown

codecov Bot commented Mar 12, 2024

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 10.94%. Comparing base (58422d3) to head (02f9b93).

Additional details and impacted files
@@           Coverage Diff           @@
##           master      #24   +/-   ##
=======================================
  Coverage   10.94%   10.94%           
=======================================
  Files           7        7           
  Lines         987      987           
  Branches      195      195           
=======================================
  Hits          108      108           
  Misses        879      879           

☔ 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.

@braingram
Copy link
Copy Markdown
Contributor

@stscirij I don't have permissions to close and re-open this to re-trigger the docs build. Doing so should show if this PR is sufficient to build the docs with 3.11.

@stscirij stscirij closed this Jan 29, 2026
@stscirij stscirij reopened this Jan 29, 2026
@zacharyburnett zacharyburnett changed the title use canonical filename of RTD configuration, enable nitpicky mode, and add fail_on_warning use canonical filename of RTD configuration, enable nitpicky mode, add fail_on_warning, and build with Python 3.13 and Sphinx 9 Feb 2, 2026
@zacharyburnett zacharyburnett changed the title use canonical filename of RTD configuration, enable nitpicky mode, add fail_on_warning, and build with Python 3.13 and Sphinx 9 use canonical filename of RTD configuration, enable nitpicky mode, and build with Python 3.13 and Sphinx 9 Feb 2, 2026
@zacharyburnett
Copy link
Copy Markdown
Collaborator Author

@stscirij @braingram this should be up-to-date now

@braingram
Copy link
Copy Markdown
Contributor

Thanks! LGTM. I'm unable to approve.

@zacharyburnett
Copy link
Copy Markdown
Collaborator Author

docs build and appear the same from looking at a few pages, so I will merge this before we diverge again

@zacharyburnett zacharyburnett merged commit 812c2c6 into spacetelescope:master Feb 2, 2026
5 of 8 checks passed
@zacharyburnett zacharyburnett deleted the rtd_update branch February 2, 2026 20:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants