search

spacetelescope / stdatamodels

https://stdatamodels.readthedocs.io
Other
5 stars 24 forks source link

switch to sphinx-rtd-theme #255

Closed braingram closed 7 months ago

braingram commented 7 months ago

https://github.com/spacetelescope/jwst/pull/8224 switched the jwst docs theme to sphinx-rtd-theme

This PR makes similar changes to this package to make it's documentation more closely match the jwst documentation.

Checklist

codecov[bot] commented 7 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Comparison is base (64e1903) 64.84% compared to head (0a9cda6) 64.84%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #255 +/- ## ======================================= Coverage 64.84% 64.84% ======================================= Files 103 103 Lines 5694 5694 ======================================= Hits 3692 3692 Misses 2002 2002 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

tapastro commented 7 months ago

Looking at the docs build, I was trying to find a sidebar expansion where scrolling was needed, and I'm not sure that it's working properly (though I can't be sure). Looking here: https://stdatamodels--255.org.readthedocs.build/en/255/jwst/datamodels/index.html

When expanding "jwst.datamodels Package", then expanding "Classes", the sidebar looks as though it should scroll to show all classes, but (my browser, at least) does not scroll at all.

braingram commented 7 months ago

@tapastro Thanks for taking a look and good eye!

The scrolling issue was fixed in https://github.com/asdf-format/sphinx-asdf/pull/88

I just made a new release of sphinx-asdf and closed and opened this PR to trigger the docs. I'm now seeing a scrolling side menu. Let me know if the new sphinx-asdf version didn't fix it for you or if you see anything else.

braingram commented 7 months ago

Also the JWST downstream tests should be fixed by: https://github.com/spacetelescope/jwst/pull/8245

I'm not sure if the current run started before or after the merge of 8245 so if it fails I can re-start that job to verify it's fixed.