# sphinx-design > A sphinx extension for designing beautiful, view size responsive web components. - **URL**: https://www.freshcrate.ai/projects/sphinx-design - **Author**: pypi - **Category**: Frameworks - **Latest version**: `0.7.0` (2026-04-21) - **License**: Unknown - **Source**: https://github.com/executablebooks/sphinx-design - **Homepage**: https://pypi.org/project/sphinx_design/ - **Language**: Python - **GitHub**: 221 stars, 67 forks - **Registry**: pypi (`sphinx-design`) - **Tags**: `components`, `design`, `extension`, `material`, `pypi`, `sphinx`, `web` ## Description # sphinx-design [![Github-CI][github-ci]][github-link] [![Coverage Status][codecov-badge]][codecov-link] [![PyPI][pypi-badge]][pypi-link] A sphinx extension for designing beautiful, view size responsive web components. Created with inspiration from [Bootstrap](https://getbootstrap.com/) (v5), [Material Design](https://material.io) and [Material-UI](https://material-ui.com/) design frameworks. ## Usage Simply pip install `sphinx-design` and add the extension to your `conf.py`: ```python extensions = ["sphinx_design"] ``` ## Supported browsers - Chrome >= 60 - Firefox >= 60 - Firefox ESR - iOS >= 12 - Safari >= 12 - Explorer >= 12 (Mirrors: ) ## Theme support View the documentation in multiple themes: - [alabaster](https://sphinx-design.readthedocs.io/en/alabaster-theme) - [sphinx-book-theme](https://sphinx-design.readthedocs.io/en/sbt-theme) - [pydata-sphinx-theme](https://sphinx-design.readthedocs.io/en/pydata-theme) - [sphinx-rtd-theme](https://sphinx-design.readthedocs.io/en/rtd-theme) - [furo](https://sphinx-design.readthedocs.io/en/furo-theme) ## Comparison to sphinx-panels This package is an iteration on [sphinx-panels](https://github.com/executablebooks/sphinx-panels) and intends to replace it. See [Migrating from sphinx-panels](./docs/get_started.md) for more information. ## Development It is recommended to use [tox](https://tox.readthedocs.io/en/latest/) to run the tests and document builds. Run `tox -va` to see all the available tox environments. To run linting, formatting and SASS compilation, use [pre-commit](https://pre-commit.com/). `pre-commit run --all css` will run the SASS compiler, for which you will need [node](https://nodejs.org) and [npm](https://www.npmjs.com/) installed, or you can directly run `npm run css`. ## TODO - note design goal; to be flexible, but limit the amount of directive nesting required. This factors in to - card header/footer syntax? (don't really want to have to use separate directives for these, hence `^^^`/`+++` syntax) - auto-wrap `grid-item` and `tab-item`, if not already inside `grid` or `tab-set`? grids items cannot contain headers; is this in anyway possible with docutils structure? naming of directives/roles: standard prefix? why are cards setup with "word-wrap: break-word;"? handle latex Use autoprefixer when compiling SASS (see ) horizontal card (grid row inside card, picture on left) subtitle for card (see ) [github-ci]: https://github.com/executablebooks/sphinx-design/workflows/continuous-integration/badge.svg?branch=main [github-link]: https://github.com/executablebooks/sphinx-design [codecov-badge]: https://codecov.io/gh/executablebooks/sphinx-design/branch/main/graph/badge.svg [codecov-link]: https://codecov.io/gh/executablebooks/sphinx-design [pypi-badge]: https://img.shields.io/pypi/v/sphinx-design.svg [pypi-link]: https://pypi.org/project/sphinx-design ## Recent releases | Version | Date | Urgency | Changes | | --- | --- | --- | --- | | `0.7.0` | 2026-04-21 | Low | Imported from PyPI (0.7.0) | | `v0.7.0` | 2026-01-19 | Low | ## What's Changed * 🧪 add regression test for available material icons by @chrisjsewell in https://github.com/executablebooks/sphinx-design/pull/224 * ⬆️ Update Material Design Icons to v4.0.0-116-ge9da21 by @2bndy5 in https://github.com/executablebooks/sphinx-design/pull/223 * 📚 Document `muted`, `white`, and `black` semantic colors by @user27182 in https://github.com/executablebooks/sphinx-design/pull/216 * ⬆️ Drop Python 3.9 & 3.10, support Python 3.14; Drop sphinx v6 by @chrisjsewell i | | `v0.7.0` | 2026-01-19 | Low | ## What's Changed * 🧪 add regression test for available material icons by @chrisjsewell in https://github.com/executablebooks/sphinx-design/pull/224 * ⬆️ Update Material Design Icons to v4.0.0-116-ge9da21 by @2bndy5 in https://github.com/executablebooks/sphinx-design/pull/223 * 📚 Document `muted`, `white`, and `black` semantic colors by @user27182 in https://github.com/executablebooks/sphinx-design/pull/216 * ⬆️ Drop Python 3.9 & 3.10, support Python 3.14; Drop sphinx v6 by @chrisjsewell i | | `v0.7.0` | 2026-01-19 | Low | ## What's Changed * 🧪 add regression test for available material icons by @chrisjsewell in https://github.com/executablebooks/sphinx-design/pull/224 * ⬆️ Update Material Design Icons to v4.0.0-116-ge9da21 by @2bndy5 in https://github.com/executablebooks/sphinx-design/pull/223 * 📚 Document `muted`, `white`, and `black` semantic colors by @user27182 in https://github.com/executablebooks/sphinx-design/pull/216 * ⬆️ Drop Python 3.9 & 3.10, support Python 3.14; Drop sphinx v6 by @chrisjsewell i | | `v0.7.0` | 2026-01-19 | Low | ## What's Changed * 🧪 add regression test for available material icons by @chrisjsewell in https://github.com/executablebooks/sphinx-design/pull/224 * ⬆️ Update Material Design Icons to v4.0.0-116-ge9da21 by @2bndy5 in https://github.com/executablebooks/sphinx-design/pull/223 * 📚 Document `muted`, `white`, and `black` semantic colors by @user27182 in https://github.com/executablebooks/sphinx-design/pull/216 * ⬆️ Drop Python 3.9 & 3.10, support Python 3.14; Drop sphinx v6 by @chrisjsewell i | | `v0.7.0` | 2026-01-19 | Low | ## What's Changed * 🧪 add regression test for available material icons by @chrisjsewell in https://github.com/executablebooks/sphinx-design/pull/224 * ⬆️ Update Material Design Icons to v4.0.0-116-ge9da21 by @2bndy5 in https://github.com/executablebooks/sphinx-design/pull/223 * 📚 Document `muted`, `white`, and `black` semantic colors by @user27182 in https://github.com/executablebooks/sphinx-design/pull/216 * ⬆️ Drop Python 3.9 & 3.10, support Python 3.14; Drop sphinx v6 by @chrisjsewell i | | `v0.7.0` | 2026-01-19 | Low | ## What's Changed * 🧪 add regression test for available material icons by @chrisjsewell in https://github.com/executablebooks/sphinx-design/pull/224 * ⬆️ Update Material Design Icons to v4.0.0-116-ge9da21 by @2bndy5 in https://github.com/executablebooks/sphinx-design/pull/223 * 📚 Document `muted`, `white`, and `black` semantic colors by @user27182 in https://github.com/executablebooks/sphinx-design/pull/216 * ⬆️ Drop Python 3.9 & 3.10, support Python 3.14; Drop sphinx v6 by @chrisjsewell i | | `v0.7.0` | 2026-01-19 | Low | ## What's Changed * 🧪 add regression test for available material icons by @chrisjsewell in https://github.com/executablebooks/sphinx-design/pull/224 * ⬆️ Update Material Design Icons to v4.0.0-116-ge9da21 by @2bndy5 in https://github.com/executablebooks/sphinx-design/pull/223 * 📚 Document `muted`, `white`, and `black` semantic colors by @user27182 in https://github.com/executablebooks/sphinx-design/pull/216 * ⬆️ Drop Python 3.9 & 3.10, support Python 3.14; Drop sphinx v6 by @chrisjsewell i | | `v0.7.0` | 2026-01-19 | Low | ## What's Changed * 🧪 add regression test for available material icons by @chrisjsewell in https://github.com/executablebooks/sphinx-design/pull/224 * ⬆️ Update Material Design Icons to v4.0.0-116-ge9da21 by @2bndy5 in https://github.com/executablebooks/sphinx-design/pull/223 * 📚 Document `muted`, `white`, and `black` semantic colors by @user27182 in https://github.com/executablebooks/sphinx-design/pull/216 * ⬆️ Drop Python 3.9 & 3.10, support Python 3.14; Drop sphinx v6 by @chrisjsewell i | | `v0.7.0` | 2026-01-19 | Low | ## What's Changed * 🧪 add regression test for available material icons by @chrisjsewell in https://github.com/executablebooks/sphinx-design/pull/224 * ⬆️ Update Material Design Icons to v4.0.0-116-ge9da21 by @2bndy5 in https://github.com/executablebooks/sphinx-design/pull/223 * 📚 Document `muted`, `white`, and `black` semantic colors by @user27182 in https://github.com/executablebooks/sphinx-design/pull/216 * ⬆️ Drop Python 3.9 & 3.10, support Python 3.14; Drop sphinx v6 by @chrisjsewell i | ## Citation - HTML: https://www.freshcrate.ai/projects/sphinx-design - Markdown: https://www.freshcrate.ai/projects/sphinx-design.md - Dependencies JSON: https://www.freshcrate.ai/api/projects/sphinx-design/deps _Generated by freshcrate.ai. Indexes pypi releases for AI-agent ecosystem packages._