search

OpenMS / pyopenms-docs

pyOpenMS readthedocs documentation, additional utilities, addons, scripts, and examples.
https://pyopenms.readthedocs.io
Other
42 stars 52 forks source link

Add furo theme #285

Closed greengypsy closed 1 year ago

greengypsy commented 2 years ago

Fixes https://github.com/OpenMS/pyopenms-docs/issues/284.

I've added furo by setting the theme in the conf.py file and adding the package to requirements.txt.

You can see the generated output at this link.

sonarcloud[bot] commented 2 years ago

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

jpfeuffer commented 2 years ago

Did you see our discussion about the "Run on Binder" button? Do you have any good suggestions? Should we try sphinx-book-theme for both documentations? It is very similar with additional support for a header on mobiles.

tapaswenipathak commented 2 years ago

On Wed, Jun 8, 2022 at 1:37 PM Julianus Pfeuffer @.***> wrote:

Did you see our discussion about the "Run on Binder" button? Do you have any good suggestions? Should we try sphinx-book-theme for both documentations? It is very similar with additional support for a header on mobiles.

I vote -1 for executablebooks/sphinx-book-theme, they make the UX more like Doxygen, rigid, constraint movements. It feels like 0/1, every click. The only thing I like is the sidebar collapses, i did some research there, should be done with moderate effort in furo as well. Furo is as smooth as it can be, i think.

— Reply to this email directly, view it on GitHub, or unsubscribe. You are receiving this because your review was requested.Message ID: @.***>

greengypsy commented 2 years ago

This is well beyond my knowledge in web design. I am struggling to come up with a solution so I've asked Rahul to have a look.

jpfeuffer commented 2 years ago

https://furo-topbar.readthedocs.io/en/latest/

Maybe we can create a fork of this. Unfortunately it is not sticky on mobile and therefore pretty useless.

jpfeuffer commented 2 years ago

Unfortunately the feature request is declined in furo. https://github.com/pradyunsg/furo/issues/57

jpfeuffer commented 2 years ago

Currently the code is in the breadcrumbs: https://github.com/OpenMS/pyopenms-docs/blob/master/docs/source/_templates/breadcrumbs.html

I made the breadcrumbs header sticky as well. Unfortunately the Binder button seems to be hidden on mobile (probably due to size) so it currently isn't perfect as well.