sphinx_design

What it is and what it does

sphinx-design is a Sphinx extension that provides a set of directives for building responsive, styled web components in reStructuredText documentation. It draws design inspiration from Bootstrap v5, Material Design, and Material-UI, offering components like cards, grids, tabs, and buttons that adapt to different viewport sizes. The extension works by adding new directives you can use in your .rst files to create visually cohesive, modern-looking documentation without hand-writing HTML or CSS.

You install it as a Python package, add it to your Sphinx conf.py, and then use its directives in your documentation source. It supports modern browsers (Chrome, Firefox, Safari, and Edge from recent versions) and works across multiple Sphinx themes. The package is actively maintained, supports current Python versions, and has no known security vulnerabilities.

Use it for:

• Building modern, visually appealing API documentation with styled cards and organized grid layouts.
• Creating tabbed content sections in technical documentation to organize related information by category.
• Designing responsive landing pages or overview sections within Sphinx-generated documentation sites.
• Migrating from sphinx-panels to a more actively maintained and feature-rich component library.
• Adding Material Design-inspired visual hierarchy to existing reStructuredText documentation projects.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

A Sphinx extension that adds responsive web component directives for building styled cards, grids, tabs, and other layout elements in documentation.

Yes. sphinx-design is a straightforward, low-friction extension for developers building Sphinx documentation who want responsive, styled components without writing custom HTML. It's actively maintained, has no security issues, uses a permissive license, and requires only Sphinx as a dependency. Install it if you want modern design aesthetics in your docs; skip it if you're comfortable with plain Sphinx styling or prefer hand-coded HTML.

Install

sphinx-design on PyPI

pip install sphinx-design

uv add sphinx-design

poetry add sphinx-design

Installing sphinx_design

Before you install

Low friction install with a single runtime dependency on sphinx. Actively maintained with recent commits and a stable release cadence; currently in Beta status but supported on modern Python versions (3.11 through 3.14).

License in practice

Licensed under MIT (permissive), allowing free use, modification, and distribution in both open and closed projects with minimal restrictions.

Quickstart

pip install sphinx-design

# In conf.py:
extensions = ["sphinx_design"]

Requires Python 3.11 or later and an existing Sphinx documentation project.

Verify before relying

• Whether all advertised theme support (alabaster, sphinx-book-theme, pydata-sphinx-theme, sphinx-rtd-theme, furo) is equally mature or if some have known limitations.
• Performance characteristics when building large documentation sites with many responsive components.
• Completeness of LaTeX/PDF export support given the TODO note about handling LaTeX.

Package facts

Evidence: sphinx_design-0.7.0-py3-none-any.whl

Keywords: sphinx, extension, material design, web components

Tags

More Python Modules packages