sphinx-doc / alabaster

Lightweight, configurable Sphinx theme
http://alabaster.readthedocs.io/
Other
734 stars 186 forks source link

Add a right sidebar if the screen width is big enough #150

Open choldgraf opened 5 years ago

choldgraf commented 5 years ago

Hello 👋 - we use a slight fork of alabaster for our repositories in the JupyterHub project. Recently I've added a sticky "on this page" sidebar to the right of pages. This lets you persist the TOC on a page and click around to jump to different sections.

The patch to add this isn't too big, mostly it involves giving the alabaster main content a little bit more space to make room for the sidebar, then adding some simple CSS to make the sidebar sticky. A PR for that can be found here: https://github.com/jupyterhub/alabaster-jupyterhub/pull/8

Would this be of interest to Alabaster in general? It seems like it's a generically-useful thing that others could benefit from. Let me know!