Repository files navigation

A sphinx extension for designing beautiful, view size responsive web components.

Created with inspiration fromBootstrap (v5),Material Design andMaterial-UI design frameworks.

Simply pip installsphinx-design and add the extension to yourconf.py:

extensions= ["sphinx_design"]

• Chrome >= 60
• Firefox >= 60
• Firefox ESR
• iOS >= 12
• Safari >= 12
• Explorer >= 12

(Mirrors:https://github.com/twbs/bootstrap/blob/v5.0.2/.browserslistrc)

View the documentation in multiple themes:

• alabaster
• sphinx-book-theme
• pydata-sphinx-theme
• sphinx-rtd-theme
• furo

This package is an iteration onsphinx-panels and intends to replace it.SeeMigrating from sphinx-panels for more information.

It is recommended to usetox to run the tests and document builds.Runtox -va to see all the available tox environments.

To run linting, formatting and SASS compilation, usepre-commit.pre-commit run --all css will run the SASS compiler, for which you will neednode andnpm installed,or you can directly runnpm run css.

• note design goal; to be flexible, but limit the amount of directive nesting required.This factors in to
  • card header/footer syntax? (don't really want to have to use separate directives for these, hence^^^/+++ syntax)
  • auto-wrapgrid-item andtab-item, if not already insidegrid ortab-set?

grids items cannot contain headers; is this in anyway possible with docutils structure?

naming of directives/roles: standard prefix?

why are cards setup with "word-wrap: break-word;"?

handle latex

Use autoprefixer when compiling SASS (seehttps://getbootstrap.com/docs/5.0/getting-started/browsers-devices/#supported-browsers)

horizontal card (grid row inside card, picture on left)

subtitle for card (seehttps://material.io/components/cards#anatomy)