sphinx-csv-filter 0.4.2

详细信息

该软件包依赖于 docutils，它提供了一个 CSVFilterDirective，扩展了 CSVTable。当作为 Sphinx 扩展使用时，它将注册 csv-filter Sphinx 指令。

安装

Sphinx CSV 过滤插件作为 pip 软件包提供。

要安装，运行

$ pip install sphinx-csv-filter

要更新，运行

$ pip install -U sphinx-csv-filter

设置

要包含此扩展，将以下行添加到您的 Sphinx 项目中的 config.py

extensions = ['crate.sphinx.csv']

如果您正在使用其他扩展，请编辑现有列表，或添加以下内容

extensions.append('crate.sphinx.csv')

使用

此插件向 csv-table 指令添加以下选项

:included_cols

这是一个以逗号分隔的列索引列表，用于包含在输出中。

:include

此选项接受一个 Python 字典，指定列索引（从零开始）和正则表达式。如果列值与提供的正则表达式匹配，则包括行。

:exclude

此选项接受一个 Python 字典，指定列索引（从零开始）和正则表达式。如果列值与提供的正则表达式匹配，则排除行。

如果一行同时匹配 :include: 和 :exclude: 过滤器，则该行将被排除。

以下是一个示例

.. csv-filter:: Example Table
   :header: Company,Contact,Country,Attend?
   :file: example.csv
   :exclude: {3: '(?i)Y\w*'}

在此示例中，如果正则表达式 (?i)Y\w* 与 Attend? 列的值匹配，则从 example.csv 中省略行。

贡献

此项目主要由 Crate.IO 维护，但我们欢迎社区贡献！

有关更多信息，请参阅 开发者文档 和 贡献文档。

帮助

需要更多帮助？

• 查看我们的 支持渠道。