Metadata-Version: 2.1
Name: sphinx-design
Version: 0.0.2
Summary: A sphinx extension for designing beautiful, view size responsive web components.
Home-page: https://github.com/executablebooks/sphinx-design
Author: Chris Sewell
Author-email: chrisj_sewell@hotmail.com
License: MIT
Keywords: sphinx extension material design web components
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: Sphinx :: Extension
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Text Processing :: Markup
Requires-Python: ~=3.6
Description-Content-Type: text/markdown
Requires-Dist: sphinx (<5,>=3)
Requires-Dist: importlib-resources (~=3.0.0) ; python_version < "3.7"
Provides-Extra: code_style
Requires-Dist: pre-commit (~=2.12) ; extra == 'code_style'
Provides-Extra: rtd
Requires-Dist: myst-parser (~=0.15.0) ; extra == 'rtd'
Provides-Extra: testing
Requires-Dist: myst-parser (~=0.15.0) ; extra == 'testing'
Requires-Dist: pytest (~=6.2) ; extra == 'testing'
Requires-Dist: pytest-cov ; extra == 'testing'
Requires-Dist: pytest-regressions ; extra == 'testing'
Provides-Extra: theme_furo
Requires-Dist: furo (==2021.7.5b38) ; extra == 'theme_furo'
Provides-Extra: theme_pydata
Requires-Dist: pydata-sphinx-theme (~=0.6.0) ; extra == 'theme_pydata'
Provides-Extra: theme_rtd
Requires-Dist: sphinx-rtd-theme (~=0.5.0) ; extra == 'theme_rtd'
Provides-Extra: theme_sbt
Requires-Dist: sphinx-book-theme (~=0.1.0) ; extra == 'theme_sbt'

# sphinx-design (IN-DEVELOPMENT)

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

Created with inspiration from [Bootstrap](https://getbootstrap.com/) (v5), [Material Design](https://material.io) and [Material-UI](https://material-ui.com/) design frameworks.

## 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](https://sphinx-design.readthedocs.io/en/latest)
- [sphinx-book-theme](https://sphinx-design.readthedocs.io/en/sbt-theme)
- [pydata-sphinx-theme](https://sphinx-design.readthedocs.io/en/pydata-theme)
- [sphinx-rtd-theme](https://sphinx-design.readthedocs.io/en/rtd-theme)
- [furo](https://sphinx-design.readthedocs.io/en/furo-theme)

## Comparison to sphinx-panels

This package is an iteration on sphinx-panels and intends to replace it.

- Replaces `panel` directive with top-level `grid` + children `grid-item-card`
  - less "bespoke" syntax
  - `grid-item` can be used when no card is needed
  - `card` can be used independently of grids
- tabs changed:
  - top-level `tab-set`
  - `tabbed` -> `tab-item`
  - include `:sync:` option to synchronize tab selection across sets
- Minimises direct use of CSS classes (encourage to not use them)
  - More declarative, easy to understand options
  - Easier to work with non-HTML outputs
  - Easier to improve/refactor
- Updated Bootstrap CSS v4 -> v5
  - top-level grid can define both column numbers and gutter sizes
- All CSS classes are prefixed with `sd-` (no clash with other theme/extension CSS)
- All colors use CSS variables (customisable)

## TODO

- 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-wrap `grid-item` and `tab-item`, if not already inside `grid` or `tab-set`?

note that directly using classes should be used as a "last resort",
and to please open an issue if you find you are commonly using a certain class.

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 (see <https://getbootstrap.com/docs/5.0/getting-started/browsers-devices/#supported-browsers>)

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

horizontally scrollable cards: (see <https://stackoverflow.com/questions/35993300/horizontally-scrollable-list-of-cards-in-bootstrap>)

div directive

subtitle for card (see <https://material.io/components/cards#anatomy>)

paragraph and tab-set in grid-item

finalise/document tab-set-code


