zcnote-sphinx-theme#

A Sphinx Theme with Sticky Sidebars.

Modify and build upon pydata-sphinx-theme with minor style altered.

PyPI status license

Examples ✨

GitHub

install with pip

pip install zcnote-sphinx-theme

configure the Sphinx docs to use the theme by editing conf.py

html_theme = "zcnote_sphinx_theme"

✨ Minor altered features#

Sticky Sidebars

Sidebars anchored to the viewport. No jumping or shifting when readers scroll to the bottom of documentation.

Slightly modified styles

Symmetrical padding, minimalist borders, and color mapping for admonition.

Hiddable Collapse Sidebar

Added configuration flags to hide the “Collapse Sidebar” buttons.