Skip to content

Add ultraplot_theme extension and shared docs assets #2

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.

Sign up for GitHub

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

Open
cvanelteren wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Add ultraplot_theme extension and shared docs assets #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
826d845
Introduce ultraplot_theme extension and move docs skin assets into Ul…
cvanelteren Feb 13, 2026
5d63451
Right TOC: place Hide next to title and only show Collapse/Expand for…
cvanelteren Feb 13, 2026
e342739
Theme: use full-width notebook output panels with theme-aware contrast
cvanelteren Feb 14, 2026
c9430c1
Theme: apply green gradient styling to header brand text
cvanelteren Feb 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,17 @@ Theme Usage
-----------

Install with `pip install sphinx-rtd-light-dark`. Then in your `conf.py` file,
add the entry ``'sphinx_rtd_light_dark'`` to the `extensions` list,
and set `html_theme` to ``'sphinx_rtd_light_dark'``.
add the entry ``'ultraplot_theme'`` to the `extensions` list,
and set `html_theme` to ``'ultraplot_theme'``.
The legacy extension/theme name ``'sphinx_rtd_light_dark'`` remains supported.

Example `conf.py`:

```python
extensions = [
...
'sphinx_rtd_light_dark',
'ultraplot_theme',
...
]
html_theme = 'sphinx_rtd_light_dark'
html_theme = 'ultraplot_theme'
```
10 changes: 7 additions & 3 deletions setup.cfg
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,19 @@ project_urls =
Source Code = https://github.com/lukelbd/sphinx_rtd_light_dark

[options]
packages = sphinx_rtd_light_dark
packages =
sphinx_rtd_light_dark
ultraplot_theme
setup_requires = setuptools>=44; toml; setuptools_scm>=3.4.3
install_requires = pygments; sphinx_rtd_theme>=2.0.0
include_package_data = True
python_requires = >=3.6.0

[options.package_data]
sphinx.sphinx_rtd_light_dark = theme.conf, static/*.css, static/*.js
sphinx_rtd_light_dark = theme.conf, static/*.css, static/*.js, static/pygments/*.css, layout.html, breadcrumbs.html
ultraplot_theme = static/*.css, static/*.js

[options.entry_points]
sphinx.html_themes =
name_of_theme = sphinx_rtd_light_dark
sphinx_rtd_light_dark = sphinx_rtd_light_dark
ultraplot_theme = ultraplot_theme
3 changes: 3 additions & 0 deletions sphinx_rtd_light_dark/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
A clean variant on the read the docs theme with light mode dark mode toggling.
"""
import os

from pygments.formatters import HtmlFormatter

# Declare themes. These should be kept updated with custom.js
Expand All @@ -26,4 +27,6 @@
# Add entrypoint for theme
# See: https://www.sphinx-doc.org/en/master/development/theming.html
def setup(app): # noqa: E302
# Keep legacy name for compatibility and add canonical UltraPlot name.
app.add_html_theme('sphinx_rtd_light_dark', base)
app.add_html_theme('ultraplot_theme', base)
Loading