Skip to content
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

Prettify the RTD pages #137

Merged
merged 4 commits into from
Dec 15, 2023
Merged

Prettify the RTD pages #137

merged 4 commits into from
Dec 15, 2023

Conversation

adybbroe
Copy link
Contributor

@adybbroe adybbroe commented Dec 14, 2023

This PR seeks to update the presentation of the on-line documentation (the Readthedoc) pages to something more nicer looking. The pages are a bit old and are using an old (default) Sphinx theme.

Here is how the current pages looks for me in Firefox:

Screenshot from 2023-12-14 13-56-28

Would be nice to have something coherent across all Pytroll RTD pages, so copying configurations from Satpy's RTD documentation.

  • Closes #xxxx
  • Tests added
  • Tests passed
  • Passes flake8 pyorbital
  • Fully documented

Signed-off-by: Adam.Dybbroe <[email protected]>
@adybbroe adybbroe self-assigned this Dec 14, 2023
Copy link

codecov bot commented Dec 14, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (86bb368) 87.50% compared to head (4ccdde8) 87.50%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #137   +/-   ##
=======================================
  Coverage   87.50%   87.50%           
=======================================
  Files          14       14           
  Lines        2209     2209           
=======================================
  Hits         1933     1933           
  Misses        276      276           
Flag Coverage Δ
unittests 87.50% <ø> (ø)

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.

@coveralls
Copy link

coveralls commented Dec 14, 2023

Coverage Status

coverage: 87.556%. remained the same
when pulling 4ccdde8 on adybbroe:rtd_facelift
into 86bb368 on pytroll:main.

@djhoese
Copy link
Member

djhoese commented Dec 14, 2023

Were the Makefile changes caused by copying Makefile from Satpy to here? It looks like Satpy's Makefile (and therefore sphinx project) may have been older. I see a lot of build options removed.

@adybbroe adybbroe changed the title Try pretify the RTD pages Try prettify the RTD pages Dec 15, 2023
@adybbroe
Copy link
Contributor Author

Off-line and locally the pages look like this for me now:
Screenshot from 2023-12-15 08-30-29

Signed-off-by: Adam.Dybbroe <[email protected]>
@adybbroe adybbroe changed the title Try prettify the RTD pages Prettify the RTD pages Dec 15, 2023
Signed-off-by: Adam.Dybbroe <[email protected]>
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.

Looks good indeed!

@mraspaud mraspaud merged commit 137e201 into pytroll:main Dec 15, 2023
17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Development

Successfully merging this pull request may close these issues.

4 participants