# sphinx-design
[![Github-CI][github-ci]][github-link]
[![Coverage Status][codecov-badge]][codecov-link]
[![PyPI][pypi-badge]][pypi-link]
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.
## Usage
Simply pip install `sphinx-design` and add the extension to your `conf.py`:
```python
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](https://sphinx-design.readthedocs.io/en/alabaster-theme)
- [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](https://github.com/executablebooks/sphinx-panels) and intends to replace it.
See [Migrating from sphinx-panels](./docs/get_started.md) for more information.
## Development
It is recommended to use [tox](https://tox.readthedocs.io/en/latest/) 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](https://pre-commit.com/).
`pre-commit run --all css` will run the SASS compiler, for which you will need [node](https://nodejs.org) and [npm](https://www.npmjs.com/) installed,
or you can directly run `npm run css`.
## 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`?
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)
subtitle for card (see <https://material.io/components/cards#anatomy>)
rtd PRs not working
[github-ci]: https://github.com/executablebooks/sphinx-design/workflows/continuous-integration/badge.svg?branch=main
[github-link]: https://github.com/executablebooks/sphinx-design
[codecov-badge]: https://codecov.io/gh/executablebooks/sphinx-design/branch/main/graph/badge.svg
[codecov-link]: https://codecov.io/gh/executablebooks/sphinx-design
[pypi-badge]: https://img.shields.io/pypi/v/sphinx-design.svg
[pypi-link]: https://pypi.org/project/sphinx-design
Raw data
{
"_id": null,
"home_page": null,
"name": "sphinx_design",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "sphinx,extension,material design,web components",
"author": null,
"author_email": "Chris Sewell <chrisj_sewell@hotmail.com>",
"download_url": "https://files.pythonhosted.org/packages/fd/d0/62a7cee178d30f7217c4badea17eeca020801c0053773098d9ff65636a60/sphinx_design-0.5.0.tar.gz",
"platform": null,
"description": "# sphinx-design\n\n[![Github-CI][github-ci]][github-link]\n[![Coverage Status][codecov-badge]][codecov-link]\n[![PyPI][pypi-badge]][pypi-link]\n\nA sphinx extension for designing beautiful, view size responsive web components.\n\nCreated with inspiration from [Bootstrap](https://getbootstrap.com/) (v5), [Material Design](https://material.io) and [Material-UI](https://material-ui.com/) design frameworks.\n\n## Usage\n\nSimply pip install `sphinx-design` and add the extension to your `conf.py`:\n\n```python\nextensions = [\"sphinx_design\"]\n```\n\n## Supported browsers\n\n- Chrome >= 60\n- Firefox >= 60\n- Firefox ESR\n- iOS >= 12\n- Safari >= 12\n- Explorer >= 12\n\n(Mirrors: <https://github.com/twbs/bootstrap/blob/v5.0.2/.browserslistrc>)\n\n## Theme support\n\nView the documentation in multiple themes:\n\n- [alabaster](https://sphinx-design.readthedocs.io/en/alabaster-theme)\n- [sphinx-book-theme](https://sphinx-design.readthedocs.io/en/sbt-theme)\n- [pydata-sphinx-theme](https://sphinx-design.readthedocs.io/en/pydata-theme)\n- [sphinx-rtd-theme](https://sphinx-design.readthedocs.io/en/rtd-theme)\n- [furo](https://sphinx-design.readthedocs.io/en/furo-theme)\n\n## Comparison to sphinx-panels\n\nThis package is an iteration on [sphinx-panels](https://github.com/executablebooks/sphinx-panels) and intends to replace it.\nSee [Migrating from sphinx-panels](./docs/get_started.md) for more information.\n\n## Development\n\nIt is recommended to use [tox](https://tox.readthedocs.io/en/latest/) to run the tests and document builds.\nRun `tox -va` to see all the available tox environments.\n\nTo run linting, formatting and SASS compilation, use [pre-commit](https://pre-commit.com/).\n`pre-commit run --all css` will run the SASS compiler, for which you will need [node](https://nodejs.org) and [npm](https://www.npmjs.com/) installed,\nor you can directly run `npm run css`.\n\n## TODO\n\n- note design goal; to be flexible, but limit the amount of directive nesting required.\n This factors in to\n - card header/footer syntax? (don't really want to have to use separate directives for these, hence `^^^`/`+++` syntax)\n - auto-wrap `grid-item` and `tab-item`, if not already inside `grid` or `tab-set`?\n\ngrids items cannot contain headers; is this in anyway possible with docutils structure?\n\nnaming of directives/roles: standard prefix?\n\nwhy are cards setup with \"word-wrap: break-word;\"?\n\nhandle latex\n\nUse autoprefixer when compiling SASS (see <https://getbootstrap.com/docs/5.0/getting-started/browsers-devices/#supported-browsers>)\n\nhorizontal card (grid row inside card, picture on left)\n\nsubtitle for card (see <https://material.io/components/cards#anatomy>)\n\nrtd PRs not working\n\n\n[github-ci]: https://github.com/executablebooks/sphinx-design/workflows/continuous-integration/badge.svg?branch=main\n[github-link]: https://github.com/executablebooks/sphinx-design\n[codecov-badge]: https://codecov.io/gh/executablebooks/sphinx-design/branch/main/graph/badge.svg\n[codecov-link]: https://codecov.io/gh/executablebooks/sphinx-design\n[pypi-badge]: https://img.shields.io/pypi/v/sphinx-design.svg\n[pypi-link]: https://pypi.org/project/sphinx-design\n",
"bugtrack_url": null,
"license": null,
"summary": "A sphinx extension for designing beautiful, view size responsive web components.",
"version": "0.5.0",
"project_urls": {
"Documentation": "https://sphinx-design.readthedocs.io",
"Homepage": "https://github.com/executablebooks/sphinx-design"
},
"split_keywords": [
"sphinx",
"extension",
"material design",
"web components"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "1752a1e9d72ecf56047df714a3dd0840a5148e4e83c100e8e0046bcea60a1054",
"md5": "e5ba87812961932387185d293d1bb998",
"sha256": "1af1267b4cea2eedd6724614f19dcc88fe2e15aff65d06b2f6252cee9c4f4c1e"
},
"downloads": -1,
"filename": "sphinx_design-0.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e5ba87812961932387185d293d1bb998",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 2173865,
"upload_time": "2023-07-27T12:45:30",
"upload_time_iso_8601": "2023-07-27T12:45:30.249103Z",
"url": "https://files.pythonhosted.org/packages/17/52/a1e9d72ecf56047df714a3dd0840a5148e4e83c100e8e0046bcea60a1054/sphinx_design-0.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "fdd062a7cee178d30f7217c4badea17eeca020801c0053773098d9ff65636a60",
"md5": "99cc391ffa2ec5c032785f9d661f47bb",
"sha256": "e8e513acea6f92d15c6de3b34e954458f245b8e761b45b63950f65373352ab00"
},
"downloads": -1,
"filename": "sphinx_design-0.5.0.tar.gz",
"has_sig": false,
"md5_digest": "99cc391ffa2ec5c032785f9d661f47bb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 2152330,
"upload_time": "2023-07-27T12:45:33",
"upload_time_iso_8601": "2023-07-27T12:45:33.302347Z",
"url": "https://files.pythonhosted.org/packages/fd/d0/62a7cee178d30f7217c4badea17eeca020801c0053773098d9ff65636a60/sphinx_design-0.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-27 12:45:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "executablebooks",
"github_project": "sphinx-design",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "sphinx_design"
}
JSON
