sphinx-design

sphinx-design extension add many components for Sphinx documentation.

Documentation: https://sphinx-design.readthedocs.io/

Install

pip install sphinx-design

Then, add the extension to your conf.py:

conf.py
extensions = [
    # ...
    "sphinx_design",
]

Examples

Grid

Tutorial

If you’re new to Python and Sphinx, this is a great place to start.

Customisation

Tailor configurations to meet your specific requirements with customizable settings.

References

Learn the syntax of reStructuredText and examine how it is formatted.

Contributing

Your contributions can make a meaningful impact and help drive the project forward!

Card

Header

Card Title

Card content

Footer

Tabs

Content 1

Content 2

foo = "str"

a = 1;

Badges

plain badge

primary, primary-line

secondary, secondary-line

success, success-line

info, info-line

warning, warning-line

danger, danger-line

light, light-line

dark, dark-line

https://example.com

explicit title

Buttons

https://example.com

Button text

https://example.com

https://example.com

https://example.com

Octicon Icons

  • alert:

  • bell:

  • book:

  • clock: