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

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

The dropdown directive combines a Bootstrap card with the HTML details tag to create a collapsible drop-down panel.

.. dropdown:: Click on me to see my content!

    I'm the content which can be anything:

    .. link-button:: https://example.com
        :text: Like a Button
        :classes: btn-primary

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

Uploaded Source

Built Distribution

sphinx_panels-0.4.0-py3-none-any.whl (74.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx-panels-0.4.0.tar.gz
  • Upload date:
  • Size: 72.7 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.1 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.7.7

File hashes

Hashes for sphinx-panels-0.4.0.tar.gz
Algorithm Hash digest
SHA256 db8c44ee5e926261829de9671aed1b1023f90bc480728b9af514f375df36d157
MD5 50ff6ce5d1737bfdc82feacc75e61e76
BLAKE2b-256 a040fdb652621d5782dce5d462b216f1cdd6067f882e7a3208a39522ad45951f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sphinx_panels-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 74.3 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.1 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.7.7

File hashes

Hashes for sphinx_panels-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 11f0c115e2b52ea089285e3201554d17d1c37cc17557e6c646ed5c10b7c58704
MD5 24a1bd30a695d9cf6e9993ebc61b3188
BLAKE2b-256 f7c58e81f540a412bae7433a6565fe30b7fb7729744617891f90ba89dabcb521

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