Skip to content

Update to support Sphinx Book Theme >=1 and Sphinx >=5#93

Merged
jrbourbeau merged 16 commits intomainfrom
dst-4
Oct 13, 2025
Merged

Update to support Sphinx Book Theme >=1 and Sphinx >=5#93
jrbourbeau merged 16 commits intomainfrom
dst-4

Conversation

@jacobtomlinson
Copy link
Copy Markdown
Member

Any stylistic differences are just from the new updates to the Book Theme. I would suggest we take a "code auto-formatter" approach here and just be unopinionated and use the defaults. We can have more in depth conversations about larger theme overhauls separately if folks have strong feelings about styling.

image

Closes #68

@jacobtomlinson jacobtomlinson changed the title Migrate setup.py -> pyproject.toml and versioneer -> hatch-vcs Update to support Sphinx Book Theme >=1 and Sphinx >=5 Oct 7, 2025
@jacobtomlinson
Copy link
Copy Markdown
Member Author

Testing this out in dask/dask#12093

@jacobtomlinson
Copy link
Copy Markdown
Member Author

jacobtomlinson commented Oct 7, 2025

This linting failure is unrelated and seems to be either a GitHub Actions or Pre Commit CI outage.

The pre-commit action needed bumping because the service it was calling no longer existed.

Copy link
Copy Markdown
Member

@jrbourbeau jrbourbeau left a comment

Choose a reason for hiding this comment

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

Thank you for working on this @jacobtomlinson! Really looking forward to removing these pins

I just took this PR (and the corresponding dask/dask PR dask/dask#12093) for a spin. I'm not seeing what you posted in your screenshot. Here's what I'm seeing locally when I install these PRs in a fresh environment

Screenshot 2025-10-07 at 11 55 20 AM

which is in line with the docs preview over in the dask/dask PR https://dask--12093.org.readthedocs.build/en/12093/

Screenshot 2025-10-07 at 11 56 05 AM

Any thoughts on what's different for you locally? Obviously yours looks better : )

@jacobtomlinson
Copy link
Copy Markdown
Member Author

Ahhh dark mode! I thought I'd successfully disabled dark mode to keep things simple, but you must have something set in your browser that's turning it on. As you can tell I didn't bother correctly styling dark mode. Let me see how much work it would be to support dark mode.

@jacobtomlinson
Copy link
Copy Markdown
Member Author

Ok dark mode should be working now. I've poked both CI's so the previews should show correctly.

image

Copy link
Copy Markdown
Member

@jrbourbeau jrbourbeau left a comment

Choose a reason for hiding this comment

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

Thanks @jacobtomlinson! Overall this looks great -- just a few small questions

Copy link
Copy Markdown
Member

@jrbourbeau jrbourbeau left a comment

Choose a reason for hiding this comment

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

Thanks @jacobtomlinson!

@jrbourbeau jrbourbeau merged commit 893758a into main Oct 13, 2025
4 checks passed
- name: Build dask-sphinx-theme dist
run: |
python -m pip install wheel twine
python setup.py sdist bdist_wheel
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@jacobtomlinson I think this line needs to be updated too. We're seeing

python: can't open file '/home/runner/work/dask-sphinx-theme/dask-sphinx-theme/setup.py': [Errno 2] No such file or directory

when this step is run on main

https://github.com/dask/dask-sphinx-theme/actions/runs/18470367546/job/52622468007

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.

Updating sphinx-book-theme version pinning

2 participants