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

Improve compatibility with common sphinx HTML themes #1172

Closed
chrisjsewell opened this issue May 7, 2024 · 0 comments · Fixed by #1182
Closed

Improve compatibility with common sphinx HTML themes #1172

chrisjsewell opened this issue May 7, 2024 · 0 comments · Fixed by #1182
Assignees

Comments

@chrisjsewell
Copy link
Member

chrisjsewell commented May 7, 2024

On looking into improving our documentation, I was seeing if we could move to the furo theme https://github.com/pradyunsg/furo, since these days it is probably the most widely used sphinx theme.

I have found this quite difficult to get looking nice with the current HTML/CSS of sphinx-needs.
As exampled by the screenshot below, you can see that our current documentation relies on quite a "delicate" mixture of CSS across multiple sources; certainly non-trivial for users to get correct

Basically, we should aim to support out-the-box some of the common sphinx themes (or at least have documentation on the CSS required).

image

Note, in sphinx-design I actually build the documentation for multiple themes (in synced repo branches). It may be overkill here, but it is a possibility:
image

@chrisjsewell chrisjsewell self-assigned this May 7, 2024
@chrisjsewell chrisjsewell changed the title Improve integration with common HTML themes Improve integration with common sphinx HTML themes May 7, 2024
@chrisjsewell chrisjsewell changed the title Improve integration with common sphinx HTML themes Improve compatibility with common sphinx HTML themes May 7, 2024
@chrisjsewell chrisjsewell linked a pull request May 18, 2024 that will close this issue
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 a pull request may close this issue.

1 participant