sphinx-panels 0.3.2


pip install sphinx-panels==0.3.2


Meta
Author: Chris Sewell

Classifiers

License
  • OSI Approved :: MIT License

Programming Language
  • Python :: 3

Topic
  • Software Development :: Libraries :: Python Modules

Framework
  • Sphinx :: Extension

sphinx-panels

Doc Status Code style: black PyPI

A sphinx extension for creating panels in a grid layout. utilising both the bootstrap 4 grid system, and cards layout.

.. panels::

    Content of the top-left panel

    ---

    Content of the top-right panel

    ---

    Content of the bottom-left panel

    ---

    Content of the bottom-right panel

Also, the link-button directive can be used to create buttons, which link to a URL (default) or reference. They can be styled by Bootstrap button classes:

.. panels::

    .. link-button:: https://example.com
        :type: url
        :tooltip: hallo
        :classes: btn-success

    ---

    This entire panel is clickable.

    +++

    .. link-button:: panels/usage
        :type: ref
        :text: Go To Reference
        :classes: btn-outline-primary btn-block stretched-link

Wheel compatibility matrix

Platform Python 3
any

Files in release

Extras:
Dependencies:
docutils
sphinx