html-section 0.1.0

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

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

Tests
PyPI
Activity
QA
Other

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. Consider using Sphinx’s .. only:: html directive for that.

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.