-
Notifications
You must be signed in to change notification settings - Fork 32
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
Change Sphinx documentation theme from Readthedocs to Furo #373
Conversation
Signed-off-by: Håkon Wiik Ånes <[email protected]>
Signed-off-by: Håkon Wiik Ånes <[email protected]>
Signed-off-by: Håkon Wiik Ånes <[email protected]>
@onatlandsmyr and @friedkitteh (or anyone else who feel like it!), could you give your thoughts, if you have any, on how the documentation looks in the furo theme vs. the Readthedocs theme? |
In general I think the furo theme is a lot easier on the eyes. However, for plots it becomes worse (imo) as the title of the plots blends with the background e.g. compared to the Readthedocs equivalent Another example: |
Thanks for the quick feedback, @friedkitteh! Yeah, Furo uses your browser's (OS') preferred light or dark theme. I have light enabled, so this is no problem for me, while I assume you have dark enabled, and so it is a problem. Apparently, we cannot at the moment force either mode (pradyunsg/furo#24). A solution could be to add a white background to all headers, perhaps... I think it is worth doing this to start using the Furo theme. |
Signed-off-by: Håkon Wiik Ånes <[email protected]>
By adding this to the Sphinx configuration file nbsphinx_execute_arguments = [
"--InlineBackend.rc=figure.facecolor='w'",
] and using >>> print(s.axes_manager)
<Axes manager, axes: (3, 3|60, 60)>
Name | size | index | offset | scale | units
================ | ====== | ====== | ======= | ======= | ======
x | 3 | 0 | 0 | 1.5 | um
y | 3 | 0 | 0 | 1.5 | um
---------------- | ------ | ------ | ------- | ------- | ------
dx | 60 | | 0 | 1 | um
dy | 60 | | 0 | 1 | um in user guide notebook cells instead of just |
Signed-off-by: Håkon Wiik Ånes <[email protected]>
Signed-off-by: Håkon Wiik Ånes <[email protected]>
Will merge after checks pass. Thanks for the feedback @friedkitteh and @onatlandsmyr! |
Description of the change
Progress of the PR
For reviewers
__init__.py
.unreleased section in
doc/changelog.rst
.