Skip to content

Add custom styling options for docs (custom.css)#3207

Open
C-Achard wants to merge 5 commits intomainfrom
cy/docs-add-custom-css
Open

Add custom styling options for docs (custom.css)#3207
C-Achard wants to merge 5 commits intomainfrom
cy/docs-add-custom-css

Conversation

@C-Achard
Copy link
Collaborator

@C-Achard C-Achard commented Feb 11, 2026

Purpose

  • Adds custom handles for the style of the Jupyter Book.
    • Custom sidebar color and footer
    • "Frosted glass" effect on header
    • Color palette based on main logo/GUI

⚠️ NOTE The current colors & theme is not to be considered final. This is meant to provide customizations handles, not enforce a particular theme. Feedback is welcome.

  • Even it the entire CCS file were merged commented, this could still be useful.
  • Not compatible with Jupyter Book >= 2.0 (Sphinx theme)
  • Custom banners/sidebar footer images can look really nice, if available we could add some

Preview

Again, color theme is not final. This is an example of what can be done.

Mode Screenshot
Dark mode Dark mode screenshot
Light mode Light mode screenshot

TODO

Details

This pull request introduces custom styling to the Sphinx documentation by adding a new CSS file and updating the Sphinx configuration to include it. The main goal is to enhance the documentation's appearance with a custom sidebar, header, and footer design for both light and dark themes.

Sphinx documentation theming:

  • Added a new custom.css file in docs/_static/ that defines custom colors and styles for sidebar, header, footer, and buttons, supporting both light and dark themes.
  • Updated _config.yml to include docs/_static as a static path and load the new custom.css file for HTML output.

@C-Achard C-Achard self-assigned this Feb 11, 2026
@C-Achard C-Achard added documentation documentation updates/comments new feature labels Feb 11, 2026
@C-Achard C-Achard requested a review from Copilot February 11, 2026 09:15
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds a custom CSS stylesheet to Jupyter Book/Sphinx docs and wires it into the Sphinx build configuration to enable theme-specific styling (sidebar/header/footer/button tweaks).

Changes:

  • Added docs/_static/custom.css defining light/dark theme CSS variables and component styling.
  • Updated _config.yml to include the static path and load custom.css during HTML builds.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

File Description
docs/_static/custom.css Introduces custom theme variables and styling overrides for the docs UI.
_config.yml Configures Sphinx to copy static assets and load the new CSS file.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@C-Achard C-Achard added the Community feedback requested Comments from the user/dev community welcomed! label Feb 11, 2026
Copy link
Collaborator

@deruyter92 deruyter92 left a comment

Choose a reason for hiding this comment

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

Love this! Great suggestion

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Community feedback requested Comments from the user/dev community welcomed! documentation documentation updates/comments new feature

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants