Skip to content

A Sphinx theme based on sphinxjp.themes.basicstrap (Bootstrap)

License

Notifications You must be signed in to change notification settings

westurner/wrd_sphinx_theme

Repository files navigation

WRD Sphinx Theme

A Sphinx theme based on sphinxjp.themes.basicstrap (Bootstrap)

  • Free software: MIT license

Features

  • Responsive layout for use with desktop and mobile browsers

  • Builds upon sphinxjp.themes.basicstrip (Bootstrap)

  • Bootstrap 3

    https://getbootstrap.com/

  • Display a fixed link ('^') to scroll to the top of the page

  • Indicate the currently-selected heading with an arrow: "⬅"

  • Indicate the currently-selected heading with an arrow in the navigation bar: "➡ "

  • (Desktop) Scroll to the selected heading in the side navigation when a heading link is clicked

  • (Desktop) Hide the top bar when scrolled beyond the top of the page

  • (Desktop) Always display the 'previous', 'next', ['modules'], and 'index' links (Desktop)

  • (Desktop) Configurable option checkboxes in the sidebar: (Desktop) A preference cookie stores the state of each checkbox between pageviews:

    • Open links in a new tab
    • Show visited links
    • Shorten links by removing HTTPS (and shorten Wikipedia links)

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.