| Name | sphinx-design-elements JSON |
| Version |
0.4.0
JSON |
| download |
| home_page | None |
| Summary | A collection of composite web elements based on components from sphinx-design. |
| upload_time | 2024-06-27 13:32:33 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | MIT License Copyright (c) 2023 Andreas Motl Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
authoring
badge
css
design
documentation
dropdown
extension
flexbox
grid
layout
markdown
material design
myst
responsive html
restructuredtext
shield
sphinx
sphinx design
table
tag
web components
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# sphinx-design-elements
ยป [Documentation]
| [Changelog]
| [PyPI]
| [Issues]
| [Source code]
| [License]
[![CI][badge-tests]][project-tests]
[![Coverage Status][badge-coverage]][project-codecov]
[![License][badge-license]][project-license]
[![Downloads per month][badge-downloads-per-month]][project-downloads]
[![Supported Python versions][badge-python-versions]][project-pypi]
[![Status][badge-status]][project-pypi]
[![Package version][badge-package-version]][project-pypi]
## About
A collection of composite and convenience web elements based on components
from [sphinx-design].
## Setup
Install the package using `pip install sphinx-design-elements`, and add the
extension to the list of `extensions` within your Sphinx configuration file
`conf.py`.
```python
extensions = [
"sphinx_design",
"sphinx_design_elements",
]
```
## Development
In order to learn how to set up a development sandbox, please visit the
[development documentation].
## Comparison to sphinx-design
[sphinx-design-elements] uses low-level components of [sphinx-design],
in order to build more high-level elements on top.
## Acknowledgements
Kudos to [Chris Sewell], [Chris Holdgraf], and all contributors for conceiving
and maintaining [MyST Parser] and [sphinx-design].
[Changelog]: https://github.com/tech-writing/sphinx-design-elements/blob/main/CHANGES.md
[Chris Holdgraf]: https://github.com/choldgraf
[Chris Sewell]: https://github.com/chrisjsewell
[development documentation]: https://sphinx-design-elements.readthedocs.io/en/latest/sandbox.html
[Documentation]: https://sphinx-design-elements.readthedocs.io/
[Issues]: https://github.com/tech-writing/sphinx-design-elements/issues
[License]: https://github.com/tech-writing/sphinx-design-elements/blob/main/LICENSE
[MyST Parser]: https://myst-parser.readthedocs.io/
[PyPI]: https://pypi.org/project/sphinx-design-elements/
[Source code]: https://github.com/tech-writing/sphinx-design-elements
[sphinx-design]: https://sphinx-design.readthedocs.io/
[sphinx-design-elements]: https://sphinx-design-elements.readthedocs.io/
[badge-coverage]: https://codecov.io/gh/tech-writing/sphinx-design-elements/branch/main/graph/badge.svg
[badge-downloads-per-month]: https://pepy.tech/badge/sphinx-design-elements/month
[badge-license]: https://img.shields.io/github/license/tech-writing/sphinx-design-elements.svg
[badge-package-version]: https://img.shields.io/pypi/v/sphinx-design-elements.svg
[badge-python-versions]: https://img.shields.io/pypi/pyversions/sphinx-design-elements.svg
[badge-status]: https://img.shields.io/pypi/status/sphinx-design-elements.svg
[badge-tests]: https://github.com/tech-writing/sphinx-design-elements/actions/workflows/main.yml/badge.svg
[project-codecov]: https://codecov.io/gh/tech-writing/sphinx-design-elements
[project-downloads]: https://pepy.tech/project/sphinx-design-elements/
[project-license]: https://github.com/tech-writing/sphinx-design-elements/blob/main/LICENSE
[project-pypi]: https://pypi.org/project/sphinx-design-elements
[project-tests]: https://github.com/tech-writing/sphinx-design-elements/actions/workflows/main.yml
Raw data
{
"_id": null,
"home_page": null,
"name": "sphinx-design-elements",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "authoring, badge, css, design, documentation, dropdown, extension, flexbox, grid, layout, markdown, material design, myst, responsive html, restructuredtext, shield, sphinx, sphinx design, table, tag, web components",
"author": null,
"author_email": "Andreas Motl <andreas.motl@panodata.org>",
"download_url": "https://files.pythonhosted.org/packages/5e/de/75a6c006be8c1db95b1e431c9af1c05b089d1d1f15d9b3fe25dc746c9814/sphinx_design_elements-0.4.0.tar.gz",
"platform": null,
"description": "# sphinx-design-elements\n\n\u00bb [Documentation]\n| [Changelog]\n| [PyPI]\n| [Issues]\n| [Source code]\n| [License]\n\n[![CI][badge-tests]][project-tests]\n[![Coverage Status][badge-coverage]][project-codecov]\n[![License][badge-license]][project-license]\n[![Downloads per month][badge-downloads-per-month]][project-downloads]\n\n[![Supported Python versions][badge-python-versions]][project-pypi]\n[![Status][badge-status]][project-pypi]\n[![Package version][badge-package-version]][project-pypi]\n\n\n## About\n\nA collection of composite and convenience web elements based on components\nfrom [sphinx-design].\n\n\n## Setup\n\nInstall the package using `pip install sphinx-design-elements`, and add the\nextension to the list of `extensions` within your Sphinx configuration file\n`conf.py`.\n\n```python\nextensions = [\n \"sphinx_design\",\n \"sphinx_design_elements\",\n]\n```\n\n## Development\n\nIn order to learn how to set up a development sandbox, please visit the\n[development documentation].\n\n\n## Comparison to sphinx-design\n\n[sphinx-design-elements] uses low-level components of [sphinx-design],\nin order to build more high-level elements on top.\n\n\n## Acknowledgements\n\nKudos to [Chris Sewell], [Chris Holdgraf], and all contributors for conceiving\nand maintaining [MyST Parser] and [sphinx-design].\n\n\n\n[Changelog]: https://github.com/tech-writing/sphinx-design-elements/blob/main/CHANGES.md\n[Chris Holdgraf]: https://github.com/choldgraf\n[Chris Sewell]: https://github.com/chrisjsewell\n[development documentation]: https://sphinx-design-elements.readthedocs.io/en/latest/sandbox.html\n[Documentation]: https://sphinx-design-elements.readthedocs.io/\n[Issues]: https://github.com/tech-writing/sphinx-design-elements/issues\n[License]: https://github.com/tech-writing/sphinx-design-elements/blob/main/LICENSE\n[MyST Parser]: https://myst-parser.readthedocs.io/\n[PyPI]: https://pypi.org/project/sphinx-design-elements/\n[Source code]: https://github.com/tech-writing/sphinx-design-elements\n[sphinx-design]: https://sphinx-design.readthedocs.io/\n[sphinx-design-elements]: https://sphinx-design-elements.readthedocs.io/\n\n[badge-coverage]: https://codecov.io/gh/tech-writing/sphinx-design-elements/branch/main/graph/badge.svg\n[badge-downloads-per-month]: https://pepy.tech/badge/sphinx-design-elements/month\n[badge-license]: https://img.shields.io/github/license/tech-writing/sphinx-design-elements.svg\n[badge-package-version]: https://img.shields.io/pypi/v/sphinx-design-elements.svg\n[badge-python-versions]: https://img.shields.io/pypi/pyversions/sphinx-design-elements.svg\n[badge-status]: https://img.shields.io/pypi/status/sphinx-design-elements.svg\n[badge-tests]: https://github.com/tech-writing/sphinx-design-elements/actions/workflows/main.yml/badge.svg\n[project-codecov]: https://codecov.io/gh/tech-writing/sphinx-design-elements\n[project-downloads]: https://pepy.tech/project/sphinx-design-elements/\n[project-license]: https://github.com/tech-writing/sphinx-design-elements/blob/main/LICENSE\n[project-pypi]: https://pypi.org/project/sphinx-design-elements\n[project-tests]: https://github.com/tech-writing/sphinx-design-elements/actions/workflows/main.yml\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023 Andreas Motl Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "A collection of composite web elements based on components from sphinx-design.",
"version": "0.4.0",
"project_urls": {
"changelog": "https://github.com/panodata/sphinx-design-elements/blob/main/CHANGES.md",
"documentation": "https://sphinx-design-elements.readthedocs.io/",
"homepage": "https://sphinx-design-elements.readthedocs.io/",
"repository": "https://github.com/panodata/sphinx-design-elements"
},
"split_keywords": [
"authoring",
" badge",
" css",
" design",
" documentation",
" dropdown",
" extension",
" flexbox",
" grid",
" layout",
" markdown",
" material design",
" myst",
" responsive html",
" restructuredtext",
" shield",
" sphinx",
" sphinx design",
" table",
" tag",
" web components"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "dfd4bd995811c7ac6c454b2840b48609bfb1551eecf47fff2ea6671a883599db",
"md5": "e57a3e16c047136921d964af4ed3928e",
"sha256": "0a2c3f13d8a0c86dad4d94e92f10830aceff7c736f9aa0a037096a9192502b3f"
},
"downloads": -1,
"filename": "sphinx_design_elements-0.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e57a3e16c047136921d964af4ed3928e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 20893,
"upload_time": "2024-06-27T13:32:28",
"upload_time_iso_8601": "2024-06-27T13:32:28.622594Z",
"url": "https://files.pythonhosted.org/packages/df/d4/bd995811c7ac6c454b2840b48609bfb1551eecf47fff2ea6671a883599db/sphinx_design_elements-0.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5ede75a6c006be8c1db95b1e431c9af1c05b089d1d1f15d9b3fe25dc746c9814",
"md5": "82cce740845bb2eef0a9db9fdb6b1a07",
"sha256": "4ce0fff78376cc233ebbf5b28598c81acb51b58e53b17765c584c9fdf92d663e"
},
"downloads": -1,
"filename": "sphinx_design_elements-0.4.0.tar.gz",
"has_sig": false,
"md5_digest": "82cce740845bb2eef0a9db9fdb6b1a07",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 40572,
"upload_time": "2024-06-27T13:32:33",
"upload_time_iso_8601": "2024-06-27T13:32:33.078876Z",
"url": "https://files.pythonhosted.org/packages/5e/de/75a6c006be8c1db95b1e431c9af1c05b089d1d1f15d9b3fe25dc746c9814/sphinx_design_elements-0.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-27 13:32:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "panodata",
"github_project": "sphinx-design-elements",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "sphinx-design-elements"
}
