Skip to main content

Sphinx extension to hide section headers with non-HTML builders.

Tests

Linux Test Status Windows Test Status macOS Test Status Coverage

PyPI

PyPI - Package Version PyPI - Supported Python Versions PyPI - Supported Implementations PyPI - Wheel

Activity

GitHub last commit GitHub commits since tagged version Maintenance PyPI - Downloads

QA

CodeFactor Grade Flake8 Status mypy status

Other

License GitHub top language Requirements Status

Installation

html-section can be installed from PyPI.

To install with pip:

$ python -m pip install html-section

Then enable the extension by adding the following to your conf.py file:

extensions = [
                ...,  # Other extensions go here
                "html_section",
                ]

Usage

Contents
-----------

.. html-section::

The section label Contents will only be shown with the HTML builder. However, the section content will still be visible, and the heading will appear in the table of contents. Consider using Sphinx’s .. only:: html directive for that.

Contents
-----------

.. latex-section::

The section label Contents will only be shown with the LaTeX builder. However, the section content will still be visible, and the heading will appear in the table of contents. Consider using Sphinx’s .. only:: latex directive for that.

New in version 0.3.0

Contents
-----------

.. phantom-section::

The section label Contents will be hidden with all builders, but the section will still exist in the structure of the document (i.e. a new section will be started, without a label). The section content will still be visible, and the heading will appear in the table of contents.

Metadata

Release files for html-section 0.3.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for html-section 0.3.0
File Size Uploaded Provenance
html_section-0.3.0.tar.gz 5.9 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for html-section 0.3.0
File Interpreter ABI Platform
html_section-0.3.0-py3-none-any.whl Python 3 none any Details

Total release size: 25.4 kB

Release files / html_section-0.3.0.tar.gz

Download URL html_section-0.3.0.tar.gz
Size 5.9 kB
Tags Source
SHA-256 checksum
How to use checksums
42ca347a114119fbdc40b692757910579fb805e8f6153c4989c3bd1d9a119423
BLAKE2b-256 checksum
How to use checksums
1aa3279ed0f3917a0137a535004e389a2bbcd87943975e846f0fc5b422127430
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.9.14

Release files / html_section-0.3.0-py3-none-any.whl

Download URL html_section-0.3.0-py3-none-any.whl
Size 19.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
f35bf301c1a7804c43557b6a2b244c7b7c42d047921297c7668795ab218c8e74
BLAKE2b-256 checksum
How to use checksums
6cc3076fd99f32ea9ceeaa38de81824a4e9c758a26cc1dd60f146f972998f59b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.9.14

Security for html-section 0.3.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page