跳转到主要内容

Sphinx扩展,用于在非HTML构建器中隐藏章节标题。

项目描述

Sphinx扩展,用于在非HTML构建器中隐藏章节标题。

测试

Linux Test Status Windows Test Status macOS Test Status Coverage

PyPI

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

活动

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

QA

CodeFactor Grade Flake8 Status mypy status

其他

License GitHub top language Requirements Status

安装

html-section 可以从PyPI安装。

使用 pip 安装

$ python -m pip install html-section

然后通过将以下内容添加到您的 conf.py 文件中来启用扩展

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

用法

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

.. html-section::

仅当使用HTML构建器时,才会显示 Contents 章节标签。但是,章节内容仍然可见,标题将出现在目录中。可以考虑使用Sphinx的 .. only:: html 指令。

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

.. latex-section::

仅当使用LaTeX构建器时,才会显示 Contents 章节标签。但是,章节内容仍然可见,标题将出现在目录中。可以考虑使用Sphinx的 .. only:: latex 指令。

新功能 0.3.0 版本

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

.. phantom-section::

该部分标签内容将在所有构建器中隐藏,但该部分仍将存在于文档结构中(即开始一个新部分,但没有标签)。部分内容仍然可见,标题将出现在目录中。

项目详情


下载文件

下载适合您平台的文件。如果您不确定选择哪个,请了解更多关于安装包的信息。

源分布

html_section-0.3.0.tar.gz (5.9 kB 查看哈希值)

上传时间

构建分布

html_section-0.3.0-py3-none-any.whl (19.5 kB 查看哈希值)

上传时间 Python 3

由以下支持

AWSAWS云计算和安全赞助商DatadogDatadog监控FastlyFastlyCDNGoogleGoogle下载分析MicrosoftMicrosoftPSF赞助商PingdomPingdom监控SentrySentry错误日志StatusPageStatusPage状态页面