Skip to main content

A clean, corporate Sphinx theme based on Bulma/SASS — no NPM required.

Project description

Manticore Sphinx Theme Dark Mode Bright Mode

A clean, elegant documentation theme for Sphinx 7+ built on Bulma CSS / SASS — with zero NPM or Node.js dependencies.

Designed for corporate software documentation, it provides an RTD-style layout with a fixed sidebar, on-page table of contents, breadcrumbs, prev/next navigation, and a fully responsive mobile experience.

Live Demonstration

Features

  • Bulma-based — uses Bulma's SASS architecture for consistent, modern styling
  • No NPM required — compiles with Python libsass or standalone dart-sass
  • RTD-style layout — fixed sidebar, scrollable content, right-rail TOC
  • Corporate design — professional colour palette, clean typography (Source Sans 3 + JetBrains Mono)
  • Fully responsive — mobile sidebar, touch-friendly, print stylesheet
  • Customisable — override colours and fonts via html_theme_options or SASS variables
  • Accessible — ARIA landmarks, keyboard navigation, skip links
  • Lightweight JS — vanilla JavaScript for sidebar toggle, scroll-spy, and keyboard shortcuts
  • Sphinx 7+ / 9.x compatible — uses the standard theme API

Quick Start

Install

pip install -e .

Use in your Sphinx project

In conf.py:

html_theme = "manticore_sphinx_theme"

html_theme_options = {
    "logo": "logo.svg",                  # optional
    "logo_alt": "My Project",
    "color_primary": "#1e3a5f",
    "color_accent": "#0077b6",
    "repo_url": "https://github.com/myorg/myproject",
    "repo_name": "GitHub",
}

Build docs

make docs          # compiles CSS then builds HTML (requires sphinx)
make docs-live     # live-reload with sphinx-autobuild

Development

Full dev setup

make dev           # installs deps, compiles CSS, installs theme

CSS compilation

The default build is standalone — no Bulma download required. All SCSS uses modern @use / @forward syntax (Dart Sass 2+/3+ compatible).

make css           # standalone build (no Bulma fetch needed)
make css-min       # minified variant
make css-watch     # watch mode (dart-sass only)
make css-bulma     # optional: compile WITH Bulma utilities layer

The css-bulma target downloads Bulma 0.9.4 SASS sources and layers them underneath the theme. Since Bulma 0.9.x uses @import internally, the Makefile passes --silence-deprecation=import to dart-sass automatically.

Project structure

manticore-sphinx-theme/
├── Makefile                    # Build system
├── pyproject.toml              # Package metadata
├── manticore_sphinx_theme/
│   ├── __init__.py             # Sphinx theme registration
│   ├── theme.conf              # Theme configuration
│   ├── layout.html             # Main Jinja2 template
│   └── static/
│       ├── sass/               # SCSS source files
│       │   ├── theme.scss              # Main entry (standalone)
│       │   ├── theme-with-bulma.scss   # Optional Bulma integration
│       │   ├── _variables.scss         # Design tokens
│       │   ├── _base.scss              # Reset & typography
│       │   ├── _layout.scss            # Grid scaffolding
│       │   ├── _sidebar.scss           # Left navigation
│       │   ├── _toc.scss               # On-page TOC
│       │   ├── _code.scss              # Code blocks
│       │   ├── _admonitions.scss       # Notes, warnings, tips
│       │   ├── _content.scss           # Sphinx domains & API docs
│       │   ├── _footer.scss            # Footer & pagination
│       │   └── _responsive.scss        # Breakpoints & print
│       ├── css/
│       │   └── theme.css               # Pre-compiled CSS (shipped)
│       └── js/
│           └── theme.js                # Vanilla JS (sidebar, scroll-spy)
└── docs/                       # Sample documentation
    ├── conf.py
    ├── index.rst
    └── ...

Customisation

Via html_theme_options

Option Default Description
color_primary #1e3a5f Primary brand colour
color_accent #0077b6 Accent / link colour
color_sidebar_bg #f5f7fa Sidebar background
navigation_depth 4 Sidebar tree depth
show_breadcrumbs True Breadcrumb trail
content_max_width 52rem Content column max width

Via SASS

For deeper changes, override _variables.scss and recompile:

make css           # recompile after editing SASS

Requirements

  • Python 3.9+
  • Sphinx 7.0+ (tested through 9.2)
  • For SASS compilation: dart-sass 2.x+ (recommended) or libsass (Python)
  • All SCSS uses modern @use / @forward — fully Dart Sass 3.x compatible
  • No NPM, Node.js, or webpack required

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

manticore_sphinx_theme-1.0.0.tar.gz (47.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

manticore_sphinx_theme-1.0.0-py3-none-any.whl (54.4 kB view details)

Uploaded Python 3

File details

Details for the file manticore_sphinx_theme-1.0.0.tar.gz.

File metadata

  • Download URL: manticore_sphinx_theme-1.0.0.tar.gz
  • Upload date:
  • Size: 47.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for manticore_sphinx_theme-1.0.0.tar.gz
Algorithm Hash digest
SHA256 539a53661cab430fb86acc09faff7501e4a03eba30fc7c20ce2d5e04ee26861b
MD5 dd66e3c4cec418a6068a56b86dc8a1b8
BLAKE2b-256 0dd8f2ad71fcd9fa30bf89a06c48b7b76795802958359b85aed052e25626b36e

See more details on using hashes here.

File details

Details for the file manticore_sphinx_theme-1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for manticore_sphinx_theme-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e888474cd9ca90e29a70055ed21d4caf9ca04de81517d1cfbfce5b718f82e4ee
MD5 6f5ce4008cf5444913a8d7277118dc26
BLAKE2b-256 d5b52157658883db5d5f6c42261a2acad5ef979198311035078cf84f19a5a54c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page