sphinx-design
A sphinx extension for designing beautiful, view size responsive web components.
Created with inspiration from Bootstrap (v5), Material Design and Material-UI design frameworks.
Usage
Simply pip install sphinx-design and add the extension to your conf.py:
extensions = ["sphinx_design"]
Supported browsers
sphinx-design targets Baseline Widely Available web features (interoperable across Chrome, Edge, Firefox and Safari for at least 30 months — the evergreen browsers of roughly the last 2½ years). Internet Explorer is not supported. See the getting started guide for details.
Theme support
View the documentation in multiple themes:
Comparison to sphinx-panels
This package is an iteration on sphinx-panels and intends to replace it. See Migrating from sphinx-panels for more information.
Development
It is recommended to use tox to run the tests and document builds.
Run tox -va to see all the available tox environments.
To run linting, formatting and CSS generation, use pre-commit.
pre-commit run --all-files css regenerates the compiled stylesheet
(sphinx_design/static/sphinx-design.min.css) from style/design.toml and the
hand-authored style/*.css; you can also run it directly with
python tools/generate_css.py.
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-itemandtab-item, if not already insidegridortab-set?
- card header/footer syntax? (don't really want to have to use separate directives for these, hence
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
horizontal card (grid row inside card, picture on left)
subtitle for card (see https://material.io/components/cards#anatomy)
1 maintainer
Metadata
1 maintainer
Release files for sphinx-design 0.8.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| sphinx_design-0.8.0.tar.gz | 2.3 MB | With provenance | Details for sphinx_design-0.8.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| sphinx_design-0.8.0-py3-none-any.whl | Python 3 | none | any | Details for sphinx_design-0.8.0-py3-none-any.whl |
Total release size: 4.5 MB
Release files / sphinx_design-0.8.0.tar.gz
| Download URL | sphinx_design-0.8.0.tar.gz |
|---|---|
| Size | 2.3 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
57fa4d96378525122947ab6109c6e490190e3119dc10f3e3adf6b71444bf3bb4
|
|
BLAKE2b-256 checksum How to use checksums |
b0c35d0f3aff52337edea9fe1d3f35ecba8a235b0490afb185544299a03a97d0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 10, 2026.
Transparency logRelease files / sphinx_design-0.8.0-py3-none-any.whl
| Download URL | sphinx_design-0.8.0-py3-none-any.whl |
|---|---|
| Size | 2.3 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
861fecb064c3da5ff48031a237692ccb7c2e671f8c4aa84d4b9eef3cb8fd9c91
|
|
BLAKE2b-256 checksum How to use checksums |
b99ae929b7fb9497d8e12bcda1777a7076f7c38d644216e91665bcfff6cab90d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 10, 2026.
Transparency logSecurity for sphinx-design 0.8.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for sphinx_design-0.8.0.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 10, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
