2.9. Paneled Content

Todo

Evaluate the integration and coexistence of this “Paneled Content” extension with all other. See conf.py for more details.

Attention

Only practicable and usable for HTML builder.

PyPI Package

https://pypi.org/project/sphinx-panels/

Documentation

https://sphinx-panels.readthedocs.io/

Git Repository

https://github.com/executablebooks/sphinx-panels

Create paneled content in Sphinx documentation when building HTML.

Features

  1. Panels in grid or cards layout.

  2. Panels with click-able link-button.

  3. Panels with toggle-able content by drop-downs.

  4. Panels with styling: header, footer, images, icons, badges, animations

For more details, see sphinx-panels in the extension demonstration and the README.md in the extension Git repository.

.. panels::

For more details, see Panels Usage.

.. dropdown::

For more details, see Dropdown Usage.

For more details, see Link Buttons.

.. div::

For more details, see Div Directive.

:badge:

For more details, see Link Badges.

:opticon:
:fa:

For more details, see Inline Icons.

Extension not applicable

This Sphinx extension is quite new and is under constant development. The current behavior disturbs the integration, so the extension is disabled for now (see conf.py). Currently known bugs are:

  • annoying side effects with the Tabbed Content extension by the automatically integrated and delivered Bootstrap 4.0 CSS

  • no proper and practical LaTeX builder support