https://github.com/tech-writing/sphinx-design-elements
A collection of composite web elements based on components from sphinx-design.
https://github.com/tech-writing/sphinx-design-elements
sphinx sphinx-doc sphinx-docs sphinx-documentation sphinx-extension sphinx-plugin sphinx-theme sphinx-themes
Last synced: 2 months ago
JSON representation
A collection of composite web elements based on components from sphinx-design.
- Host: GitHub
- URL: https://github.com/tech-writing/sphinx-design-elements
- Owner: tech-writing
- License: mit
- Created: 2023-07-18T20:12:45.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2026-01-21T05:35:29.000Z (5 months ago)
- Last Synced: 2026-01-21T17:03:10.119Z (5 months ago)
- Topics: sphinx, sphinx-doc, sphinx-docs, sphinx-documentation, sphinx-extension, sphinx-plugin, sphinx-theme, sphinx-themes
- Language: Python
- Homepage: https://sphinx-design-elements.readthedocs.io/
- Size: 148 KB
- Stars: 4
- Watchers: 1
- Forks: 2
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- License: LICENSE
Awesome Lists containing this project
README
# sphinx-design-elements
» [Documentation]
| [Changelog]
| [PyPI]
| [Issues]
| [Source code]
| [License]
[![CI][badge-tests]][project-tests]
[![Coverage Status][badge-coverage]][project-codecov]
[![License][badge-license]][project-license]
[![Downloads per month][badge-downloads-per-month]][project-downloads]
[![Status][badge-status]][project-pypi]
[![Package version][badge-package-version]][project-pypi]
[![Supported Python versions][badge-python-versions]][project-pypi]
[![Supported Sphinx versions][badge-sphinx-versions]][project-sphinx]
[![Supported docutils versions][badge-docutils-versions]][project-docutils]
## 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`.
```python
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].
[Changelog]: https://github.com/tech-writing/sphinx-design-elements/blob/main/CHANGES.md
[Chris Holdgraf]: https://github.com/choldgraf
[Chris Sewell]: https://github.com/chrisjsewell
[development documentation]: https://sphinx-design-elements.readthedocs.io/en/latest/sandbox.html
[Documentation]: https://sphinx-design-elements.readthedocs.io/
[Issues]: https://github.com/tech-writing/sphinx-design-elements/issues
[License]: https://github.com/tech-writing/sphinx-design-elements/blob/main/LICENSE
[MyST Parser]: https://myst-parser.readthedocs.io/
[PyPI]: https://pypi.org/project/sphinx-design-elements/
[Source code]: https://github.com/tech-writing/sphinx-design-elements
[sphinx-design]: https://sphinx-design.readthedocs.io/
[sphinx-design-elements]: https://sphinx-design-elements.readthedocs.io/
[badge-coverage]: https://codecov.io/gh/tech-writing/sphinx-design-elements/branch/main/graph/badge.svg
[badge-downloads-per-month]: https://static.pepy.tech/badge/sphinx-design-elements/month
[badge-license]: https://img.shields.io/github/license/tech-writing/sphinx-design-elements.svg
[badge-docutils-versions]: https://img.shields.io/badge/docutils-0.19%20--%200.22-blue.svg
[badge-package-version]: https://img.shields.io/pypi/v/sphinx-design-elements.svg
[badge-python-versions]: https://img.shields.io/pypi/pyversions/sphinx-design-elements.svg
[badge-sphinx-versions]: https://img.shields.io/badge/sphinx-5.1%20--%209.*-blue.svg
[badge-status]: https://img.shields.io/pypi/status/sphinx-design-elements.svg
[badge-tests]: https://github.com/tech-writing/sphinx-design-elements/actions/workflows/main.yml/badge.svg
[project-codecov]: https://codecov.io/gh/tech-writing/sphinx-design-elements
[project-downloads]: https://pepy.tech/project/sphinx-design-elements
[project-docutils]: https://docutils.sourceforge.io/
[project-license]: https://github.com/tech-writing/sphinx-design-elements/blob/main/LICENSE
[project-pypi]: https://pypi.org/project/sphinx-design-elements
[project-sphinx]: https://www.sphinx-doc.org/
[project-tests]: https://github.com/tech-writing/sphinx-design-elements/actions/workflows/main.yml