Skip to main content

A sphinx extension for creating panels in a grid layout.

Project description

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx-panels-0.3.1.tar.gz (10.9 kB view details)

Uploaded Source

Built Distribution

sphinx_panels-0.3.1-py3-none-any.whl (12.0 kB view details)

Uploaded Python 3

File details

Details for the file sphinx-panels-0.3.1.tar.gz.

File metadata

  • Download URL: sphinx-panels-0.3.1.tar.gz
  • Upload date:
  • Size: 10.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.3.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.7.7

File hashes

Hashes for sphinx-panels-0.3.1.tar.gz
Algorithm Hash digest
SHA256 82d3c13ebd799936d94c2635f9907a1edc818b92ddd439c2bd77aaff953f5536
MD5 2a925306092b4d4ae388e4dc5a262631
BLAKE2b-256 6ffc090ea34af6af401e0a66b97e021dadbc502771feac86fea2d445943c484a

See more details on using hashes here.

File details

Details for the file sphinx_panels-0.3.1-py3-none-any.whl.

File metadata

  • Download URL: sphinx_panels-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 12.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.3.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.7.7

File hashes

Hashes for sphinx_panels-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 38918a6f7cd62f1a104526bd4a60d4c5b376ce89dc88fee8ea7ce6e3b20f86ab
MD5 457b7b4a493a1b5143ebc3cf34d11c7a
BLAKE2b-256 d60c27b14d5d69ba23de47f0d896a77e61b9a38e85372b1e50aefaada122bb14

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page