Furo50 documentation

A sphinx extension that turns Furo theme into CS50’s theme.

Prerequisites

To use this extension you will need Furo theme for your project.

Install furo theme and update html_theme in the sphinx configuration

Usage

  1. Install Furo50 extension in your sphinx environment.

    pip install furo50

  2. In the conf.py configuration file, add furo50 to the extensions list.

    extensions = [
    ...
    'furo50'
    ...
]

Your Sphinx documentation’s HTML pages will now be generated with this CS50 theme! 🎉

Features

  • CS50-Inspired Design: Emulates the look and feel of CS50’s course pages.

  • Easy Configuration: Simple configuration addition needed in conf.py for quick setup and customization.

  • Syntax Highlighting: Incorporates CS50-style syntax highlighting for code blocks, improving code readability.

  • Sidebar Styles: Offers both crimson (CS50) and black (CS50X) sidebar options, allowing users to choose their preferred aesthetic.

  • Seamless Furo Integration: Built on top of the Furo theme, and is compatible with Furo’s existing features and customizations.

  • and more …