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.

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

Jump to bottom

Adopt a derivative of the sphinx-book-theme for our documentation #289

Open
Cadair opened this issue Aug 9, 2023 · 0 comments
Open

Adopt a derivative of the sphinx-book-theme for our documentation #289

Cadair opened this issue Aug 9, 2023 · 0 comments
Labels
Documentation docs docs docs Feature Request Upstream Issue An issue which is probably in an upstream package of the user tools

Comments

@Cadair
Copy link
Member

Cadair commented Aug 9, 2023

We should adopt sphinx-book-theme for a multitude of reasons, some of which are:

  • Actively maintained.
  • Dark/Light theme support.
  • Better accessibility primitives, and easier to meet accessibility guidelines (pygments styles etc).
  • much improved rendering of code cells in the jupyter notebook content.

SunPy is also working on this sunpy/sunpy-sphinx-theme#206 so we should probably customise the sunpy theme to get the top nav we need etc.
@Cadair Cadair added Feature Request Upstream Issue An issue which is probably in an upstream package of the user tools Documentation docs docs docs labels Aug 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation docs docs docs Feature Request Upstream Issue An issue which is probably in an upstream package of the user tools
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@Cadair