{"id":10249,"library":"sphinx-panels","title":"Sphinx Panels","description":"sphinx-panels is a Sphinx extension that enables creating responsive panel layouts in reStructuredText or MyST Markdown. It allows arranging content into cards, grids, and more, leveraging Bootstrap-like CSS. The current version is 0.6.0, with releases occurring intermittently based on feature development and bug fixes.","status":"active","version":"0.6.0","language":"python","source_language":"en","source_url":"https://github.com/executablebooks/sphinx-panels","tags":["Sphinx","documentation","UI","layout","reStructuredText","MyST"],"install":[{"cmd":"pip install sphinx-panels","lang":"bash","label":"Install latest version"}],"dependencies":[{"reason":"Core dependency for Sphinx extensions.","package":"sphinx","optional":false}],"imports":[{"note":"Sphinx extensions are activated by adding their name to the `extensions` list in `conf.py`, not by importing Python modules directly into your project's code.","wrong":"from sphinx_panels import ...","symbol":"Extension activation","correct":"extensions = ['sphinx_panels']"}],"quickstart":{"code":"# conf.py\nproject = 'My Panel Project'\ncopyright = '2024, Your Name'\n\nextensions = [\n    'sphinx.ext.autodoc',\n    'sphinx_panels' # Enable the extension\n]\n\nhtml_theme = 'alabaster'\n\n# example.rst (or .md if using MyST)\n# .. grid:: 1 2 2 3\n#    :gutter: 2\n#\n#    .. grid-item-card:: Card Title 1\n#       :shadow: sm\n#\n#       This is the content for the first card.\n#\n#    .. grid-item-card:: Card Title 2\n#       :shadow: sm\n#\n#       This is the content for the second card.\n#\n#    .. grid-item-card:: Card Title 3\n#       :shadow: sm\n#\n#       This is the content for the third card.","lang":"python","description":"To use sphinx-panels, first enable it in your Sphinx project's `conf.py` file by adding 'sphinx_panels' to the `extensions` list. Then, you can use directives like `.. grid::` or `.. panel::` in your reStructuredText or MyST Markdown files."},"warnings":[{"fix":"Consult the v0.2.0 changelog and updated documentation for the new class structure and directive options. Re-evaluate and update any custom CSS or directive usage.","message":"Prior to v0.2.0, sphinx-panels underwent a 'Major Revamp'. The CSS classes and internal structure for panels were significantly different. Existing `.. panel::` directives or custom CSS relying on pre-0.2.0 structure may break.","severity":"breaking","affected_versions":"<0.2.0 to 0.2.0+"},{"fix":"Update directive options to follow the new, more explicit syntax as shown in the latest documentation. For example, options might require a `key: value` format instead of just a bare `key`.","message":"In v0.3.0, the option syntax for directives like `.. panel::` or `.. grid::` was improved. Older, less explicit syntax might no longer be parsed correctly, leading to build failures or incorrect rendering.","severity":"breaking","affected_versions":"<0.3.0 to 0.3.0+"},{"fix":"If panels are not rendering as expected, use browser developer tools to inspect the generated HTML and CSS. Look for conflicting styles and consider adding custom CSS in your `_static/custom.css` to override them, or experiment with a different Sphinx theme.","message":"Some Sphinx themes may have CSS rules that conflict with `sphinx-panels`, especially regarding button styling or general layout, leading to unexpected rendering or overridden styles.","severity":"gotcha","affected_versions":"All versions"}],"env_vars":null,"search_vec":"'0.6.0':39 'allow':22 'arrang':23 'base':44 'bootstrap':32 'bootstrap-lik':31 'bug':49 'card':26 'content':24 'creat':12 'css':34 'current':36 'develop':47 'document':52 'enabl':11 'extens':9 'featur':46 'fix':50 'grid':27 'intermitt':43 'layout':15,54 'leverag':30 'like':33 'markdown':20 'myst':19,56 'occur':42 'panel':2,5,14 'releas':41 'respons':13 'restructuredtext':17,55 'sphinx':1,4,8,51 'sphinx-panel':3 'ui':53 'version':37","created_at":"2026-04-17T01:23:09.598402+00:00","updated_at":"2026-04-17T01:23:09.598402+00:00","problems":{"verify_error":"no import statement found"},"ecosystem":"pypi","meta_description":null,"install_score":null,"quickstart_score":null,"quickstart_tag":null,"pypi_latest":"0.6.0","cli_name":"","cli_version":null,"type":"library","homepage":null,"github":"https://github.com/executablebooks/sphinx-panels","docs":"https://sphinx-panels.readthedocs.io","changelog":null,"pypi":"https://pypi.org/project/sphinx-panels/","npm":null,"openapi_spec":null,"status_page":null,"smithery":null,"categories":["web-framework"],"base_url":null,"auth_type":null,"provenance":{"verified_status":"skip","verified_at":"2026-06-28","last_verified":"2026-06-28","next_check":"2026-07-05","install_tag":null}}