{"id":13557243,"url":"https://github.com/executablebooks/sphinx-panels","last_synced_at":"2025-12-30T00:43:33.283Z","repository":{"id":37036986,"uuid":"260360729","full_name":"executablebooks/sphinx-panels","owner":"executablebooks","description":"A sphinx extension for creating panels in a grid layout","archived":false,"fork":false,"pushed_at":"2023-12-18T18:52:44.000Z","size":495,"stargazers_count":86,"open_issues_count":32,"forks_count":19,"subscribers_count":11,"default_branch":"master","last_synced_at":"2025-03-01T03:35:42.612Z","etag":null,"topics":["bootstrap","cards","grid-layout","panels","sphinx","sphinx-extension"],"latest_commit_sha":null,"homepage":"https://sphinx-panels.readthedocs.io","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/executablebooks.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2020-05-01T02:10:03.000Z","updated_at":"2024-11-01T07:01:16.000Z","dependencies_parsed_at":"2024-02-29T05:47:32.452Z","dependency_job_id":null,"html_url":"https://github.com/executablebooks/sphinx-panels","commit_stats":{"total_commits":59,"total_committers":6,"mean_commits":9.833333333333334,"dds":"0.15254237288135597","last_synced_commit":"44bab2341d97707365396efc0b23a1edac26da7c"},"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/executablebooks%2Fsphinx-panels","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/executablebooks%2Fsphinx-panels/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/executablebooks%2Fsphinx-panels/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/executablebooks%2Fsphinx-panels/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/executablebooks","download_url":"https://codeload.github.com/executablebooks/sphinx-panels/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246992998,"owners_count":20865919,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bootstrap","cards","grid-layout","panels","sphinx","sphinx-extension"],"created_at":"2024-08-01T12:04:14.197Z","updated_at":"2025-12-30T00:43:33.239Z","avatar_url":"https://github.com/executablebooks.png","language":"Python","funding_links":[],"categories":["Python","bootstrap"],"sub_categories":[],"readme":"# sphinx-panels\n\n[![Doc Status][rtd-badge]][rtd-link]\n[![Code style: black][black-badge]][black-link]\n[![PyPI][pypi-badge]][pypi-link]\n\n🚨This repository is not actively maintained. Use [`sphinx-design`](https://github.com/executablebooks/sphinx-design) instead! See [the migration guide](https://sphinx-design.readthedocs.io/en/latest/get_started.html#migrating-from-sphinx-panels) and [this github issue](https://github.com/executablebooks/sphinx-design/issues/51) for more information.🚨\n\nA sphinx extension for creating document components optimised for HTML+CSS.\n\n- The `panels` directive creates panels of content in a grid layout, utilising both the Bootstrap 4 [grid system](https://getbootstrap.com/docs/4.0/layout/grid/), and [cards layout](https://getbootstrap.com/docs/4.0/components/card/).\n\n- The `link-button` directive creates a click-able button, linking to a URL or reference, and can also be used to make an entire panel click-able.\n\n- The `dropdown` directive creates toggle-able content.\n\n- The `tabbed` directive creates tabbed content.\n\n- `opticon` and `fa` (fontawesome) roles allow for inline icons to be added.\n\n\n```rst\n.. panels::\n\n    Content of the top-left panel\n\n    ---\n\n    Content of the top-right panel\n\n    ---\n\n    Content of the bottom-left panel\n\n    ---\n\n    Content of the bottom-right panel\n```\n\nThe `link-button` directive can be used to create buttons, which link to a URL (default) or reference.\nThey can be styled by [Bootstrap button classes](https://getbootstrap.com/docs/4.0/components/buttons/):\n\n```rst\n.. panels::\n\n    .. link-button:: https://example.com\n        :type: url\n        :tooltip: hallo\n        :classes: btn-success\n\n    ---\n\n    This entire panel is clickable.\n\n    +++\n\n    .. link-button:: panels/usage\n        :type: ref\n        :text: Go To Reference\n        :classes: btn-outline-primary btn-block stretched-link\n```\n\nThe `dropdown` directive combines a [Bootstrap card](https://getbootstrap.com/docs/4.0/components/card/)\nwith the [HTML details tag](https://www.w3schools.com/tags/tag_details.asp) to create a collapsible\ndrop-down panel.\n\n```rst\n.. dropdown:: Click on me to see my content!\n\n    I'm the content which can be anything:\n\n    .. link-button:: https://example.com\n        :text: Like a Button\n        :classes: btn-primary\n```\n\n## Development\n\nTo run the tests:\n\n```console\npip install tox\ntox -e py37-sphinx3\n```\n\nTo test building the docs:\n\n```console\ntox -e docs-clean html\ntox -e docs-rebuild html\n```\n\nFor live builds of the docs:\n\n```console\ntox -e docs-live html\n```\n\nYou can also build the docs in different themes, by setting `HTML_THEME` to one of `alabaster`, `sphinx_rtd_theme`, `pydata_sphinx_theme`, `sphinx_book_theme`:\n\n```console\nexport HTML_THEME=sphinx_book_theme\ntox -e docs-live\n```\n\nFor code style and SCSS -\u003e CSS updating:\n\n```console\npip install pre-commit\npre-commit run --all\n```\n\n[rtd-badge]: https://readthedocs.org/projects/sphinx-panels/badge/?version=latest\n[rtd-link]: https://sphinx-panels.readthedocs.io/en/latest/?badge=latest\n[black-badge]: https://img.shields.io/badge/code%20style-black-000000.svg\n[black-link]: https://github.com/ambv/black\n[pypi-badge]: https://img.shields.io/pypi/v/sphinx-panels.svg\n[pypi-link]: https://pypi.org/project/sphinx-panels\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fexecutablebooks%2Fsphinx-panels","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fexecutablebooks%2Fsphinx-panels","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fexecutablebooks%2Fsphinx-panels/lists"}