Skip to main content

Add inline tabbed content to your Sphinx documentation.

Project description

Sphinx Inline Tabs

demo image

Add inline tabbed content to your Sphinx documentation.

Installation

This project is available on PyPI, and can be installed using pip:

pip install sphinx-inline-tabs

You'll also want to add the extension to extensions in conf.py:

extensions = [
    ...,
    "sphinx_inline_tabs",
    ...,
]

Features

  • Elegant design: Small footprint in the markup and generated website, while looking good.
  • Configurable: All the colors can be configured using CSS variables.
  • Synchronisation: Tabs with the same label all switch with a single click.
  • Works without JavaScript: JavaScript is not required for the basics, only for synchronisation.

Contributing

sphinx-inline-tabs is a volunteer maintained open source project, and we welcome contributions of all forms. This is a fairly small package, and the development workflow is very similar to Furo's development workflow.

The Code of Conduct applies within all community spaces. If you are not familiar with our Code of Conduct policy, take a minute to read the policy before starting with your first contribution.

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_inline_tabs-2021.3.19b5.tar.gz (41.7 kB view details)

Uploaded Source

Built Distribution

sphinx_inline_tabs-2021.3.19b5-py3-none-any.whl (6.6 kB view details)

Uploaded Python 3

File details

Details for the file sphinx_inline_tabs-2021.3.19b5.tar.gz.

File metadata

  • Download URL: sphinx_inline_tabs-2021.3.19b5.tar.gz
  • Upload date:
  • Size: 41.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.7.3 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.8.3

File hashes

Hashes for sphinx_inline_tabs-2021.3.19b5.tar.gz
Algorithm Hash digest
SHA256 c35a83b4ee6f6a3c2b475c665ea4720c86af617a8b7635b3f1ead3af45cdeb14
MD5 e9f0ba80cac114fa370654b2c566e979
BLAKE2b-256 b40a99c2385e5ddd95b8b987765a1adc829ac58bb70bedbbc8445557da3bf41d

See more details on using hashes here.

Provenance

File details

Details for the file sphinx_inline_tabs-2021.3.19b5-py3-none-any.whl.

File metadata

  • Download URL: sphinx_inline_tabs-2021.3.19b5-py3-none-any.whl
  • Upload date:
  • Size: 6.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.7.3 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.8.3

File hashes

Hashes for sphinx_inline_tabs-2021.3.19b5-py3-none-any.whl
Algorithm Hash digest
SHA256 3a63bc3d0921ad57d0bc8737405ffebc08a492ad88b1c51adf31be89a8935f16
MD5 99df137f928341207e04ac51729fc047
BLAKE2b-256 a1b2dbf625195107b3e84f5f2b137a6e8ea8b9d4c7f1da14a1f2a67ea469b877

See more details on using hashes here.

Provenance

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