sphinx-design-elements#

ยป Documentation | Changelog | PyPI | Issues | Source code | License

CI Coverage Status PyPI

About#

A collection of composite 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",
]

Comparison to sphinx-design#

This package uses low-level components of sphinx-design, in order to build more high-level elements on top.

Development#

In order to learn how to set up the project in development mode, please visit the development documentation.

Acknowledgements#

Kudos to Chris Sewell and all contributors for conceiving and maintaining MyST Parser and sphinx-design.