About Theme

Description

  • This is an out-of-the-box implementation of the Sphinx RTD Theme v0.4.3.

  • The configuration for this theme will eventualy be converted into a boilerplate project on it’s own.

  • The layout for this configuration is outlined below.

  • For more configuration specifics see the (relatively organized) developer notes

Current features for this theme boilerplate configuration

  • The main index page and subsequent section introductions (including this page) import the development README.md files via the m2r Sphinx extension.

  • A compartmentalized config.py:

    • most configuration will move to yaml in the future

    • Custom CSS settings:

    • Widen visible content area

    • normalize preformatted text widths

    • dynamically avoid ‘Fork me on Github’ component conflicts

  • Configurable ‘Fork me on Github’ ribbon

  • Custom colorization for TOC sidebar items

  • TOC class method itimization in sidebar: