A collection of composite web elements based on components from sphinx-design.
Project Links
Meta
Author: Andreas Motl
Requires Python: >=3.9
Classifiers
Development Status
- 4 - Beta
Environment
- Plugins
- Web Environment
Framework
- Sphinx
- Sphinx :: Extension
Intended Audience
- Customer Service
- Developers
- Education
- End Users/Desktop
- Information Technology
- Manufacturing
- Science/Research
- System Administrators
- Telecommunications Industry
License
- OSI Approved :: MIT License
Programming Language
- Python :: 3 :: Only
- Python :: 3.9
- Python :: 3.10
- Python :: 3.11
- Python :: 3.12
- Python :: 3.13
- Python :: 3.14
- Python :: Implementation :: CPython
Topic
- Documentation
- Documentation :: Sphinx
- Education
- File Formats
- Scientific/Engineering
- Software Development :: Bug Tracking
- Software Development :: Code Generators
- Software Development :: Documentation
- Software Development :: Libraries :: Python Modules
- Software Development :: Widget Sets
- Text Processing
- Text Processing :: Markup
- Text Processing :: Markup :: HTML
- Text Processing :: Markup :: Markdown
- Text Processing :: Markup :: reStructuredText
sphinx-design-elements
» Documentation | Changelog | PyPI | Issues | Source code | License
About
A collection of composite and convenience web elements based on components from sphinx-design.
Setup
Install the package using pip install sphinx-design-elements, and add the
extension to the list of extensions within your Sphinx configuration file
conf.py.
extensions = [
"sphinx_design",
"sphinx_design_elements",
]
Development
In order to learn how to set up a development sandbox, please visit the development documentation.
Comparison to sphinx-design
sphinx-design-elements uses low-level components of sphinx-design, in order to build more high-level elements on top.
Acknowledgements
Kudos to Chris Sewell, Chris Holdgraf, and all contributors for conceiving and maintaining MyST Parser and sphinx-design.
0.4.2
Jan 21, 2026
0.4.1
Dec 14, 2025
0.4.0
Jun 27, 2024
0.3.2
May 28, 2024
0.3.1
Apr 10, 2024
0.3.0
Apr 06, 2024
0.2.1
Aug 08, 2023
0.2.0
Aug 07, 2023
0.1.0
Jul 19, 2023
Wheel compatibility matrix
Files in release
Extras:
Dependencies:
beautifulsoup4
docutils
(<0.23)
myst-parser
sphinx
(<10)
sphinx-design
(<0.8,>=0.6.1)
standard-imghdr