{"library":"sphinx-panels","title":"Sphinx Panels","type":"library","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.","language":"python","status":"active","last_verified":"Fri Apr 17","install":{"commands":["pip install sphinx-panels"],"cli":null},"imports":["extensions = ['sphinx_panels']"],"auth":{"required":false,"env_vars":[]},"links":{"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},"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.","tag":null,"tag_description":null,"last_tested":null,"results":[]},"compatibility":null}