Skip to content

Switch to Pydata Theme #844

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

Merged
merged 1 commit into from
Jul 24, 2025
Merged

Switch to Pydata Theme #844

merged 1 commit into from
Jul 24, 2025

Conversation

kprosise
Copy link
Contributor

@kprosise kprosise commented Jul 22, 2025

In addition to theme specific changes, conf.py had some cruft removed. Index pages added for all sections that lacked them, to facilitate the new layout.

Changes were checked running sphinx-autobuild as a dev server.

This commit addresses to FFTK-4171, "Switch to PyData Theme"

PR Template and Checklist

Please complete as much as possible to speed up the reviewing process.

Readiness and adding reviewers as appropriate is required.

All PRs should be reviewed by a technical writer/documentation team and a peer.
If effecting customers—which is a majority of content changes—a member of Customer Success must also review.

Readiness

  • Merge (pending reviews)
  • Merge after date or event
  • Draft

Overview

New theme, version selection, banners, and more!

Checklist

  • Run spelling and grammar check, preferably with linter.
  • Avoid changing any header associated with a link/reference.
  • Step through instructions (or ask someone to do so).
  • Review for wordiness
  • Match tone and style of page/section.
  • Run make linkcheck.
  • View HTML in a browser to check rendering.
  • Use semantic newlines.
  • follow best practices for commits.
    • Descriptive title written in the imperative.
    • Include brief overview of QA steps taken.
    • Mention any related issues numbers.
    • End message with sign off/DCO line (-s, --signoff).
    • Sign commit with your gpg key (-S, --gpg-sign).
    • Squash commits if needed.
  • Request PR review by a technical writer and at least one peer.

Comments

Any thing else that a maintainer/reviewer should know.
This could include potential issues, rational for approach, etc.

@kprosise
Copy link
Contributor Author

Copy link
Member

@MiloCasagrande MiloCasagrande left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I all looks awesome @kprosise!
Only one small comment, otherwise all good.

@kprosise kprosise marked this pull request as ready for review July 23, 2025 09:59
@kprosise
Copy link
Contributor Author

@kprosise kprosise requested a review from MiloCasagrande July 23, 2025 10:52
Copy link
Member

@MiloCasagrande MiloCasagrande left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks @kprosise!

In addition to theme specific changes, conf.py had some cruft removed.
Index pages added for all sections that lacked them, to facilitate the
new layout.

Changes were checked running `sphinx-autobuild` as a dev server.

This commit addresses to FFTK-4171, "Switch to PyData Theme"

Signed-off-by: Katrina Prosise <[email protected]>
@kprosise kprosise merged commit 08698e4 into foundriesio:main Jul 24, 2025
1 of 3 checks passed
@kprosise kprosise deleted the change-theme branch July 24, 2025 07:55
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.

2 participants