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
Chrome >= 60
Firefox >= 60
Firefox ESR
iOS >= 12
Safari >= 12
Explorer >= 12
(Mirrors: https:/github.com/twbs/bootstrap/blob/v5.0.2/.browserslistrc)
Theme support
View the documentation in multiple themes:
alabaster
sphinx-book-theme
pydata-sphinx-theme
sphinx-rtd-theme
furo
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 SASS compilation, use pre-commit.
pre-commit run --all css will run the SAS
|