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.2.tar.gz (11.0 kB view details)

Uploaded Source

Built Distribution

sphinx_panels-0.3.2-py3-none-any.whl (12.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx-panels-0.3.2.tar.gz
  • Upload date:
  • Size: 11.0 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.2.tar.gz
Algorithm Hash digest
SHA256 bebb503961a811e714d1eaeb796d9508fd00b95111d9627bc84e9654065f95de
MD5 9f5338f003462cfd948cd866da190332
BLAKE2b-256 9dc1eb7f24ef68416b0da1eef572e3fa363899249170d1b7bdbb12ef6049b552

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sphinx_panels-0.3.2-py3-none-any.whl
  • Upload date:
  • Size: 12.1 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 63266c6a9df335ddfed7e45ae32bcfd71db960bd775ef7f45f5e72266424c600
MD5 e865b0db829cb6fd5a9c713cba3dbc26
BLAKE2b-256 90f1c18d05282ca5b99c6774b115c302687bf1cfd66cc4e340c238c73b97596b

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