用于板条箱文档的Sphinx CSV筛选器扩展

sphinx-csv-filter的Python项目详细描述


扩展要添加的csv-tablereStructuredText指令的Sphinx插件 行筛选选项。

先决条件

您需要使用sphinx和structuredtext。

安装

sphinx csv过滤器插件作为pip包提供。

要安装,请运行:

$ pip install sphinx-csv-filter

要更新,请运行:

$ pip install -U sphinx-csv-filter

设置

要包含扩展名,请将此行添加到config.pyin 您的狮身人面像项目:

extensions = ['crate.sphinx.csv']

如果使用其他扩展名,请编辑现有列表,或添加以下内容:

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

使用

此插件将:exclude:选项添加到csv-table指令。此选项采用python dict指定列索引(从零开始)和正则表达式。如果列值与提供的正则表达式匹配,则排除行。

下面是一个示例:

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

在本例中,如果正则表达式(?i)Y\w*Attend?列的值匹配,则输出中将省略example.csv中的行。

贡献

这个项目主要由Crate.io维护,但是我们欢迎社区 贡献!

有关详细信息,请参见developer docscontribution docs

帮助

寻求更多帮助?

欢迎加入QQ群-->: 979659372 Python中文网_新手群

推荐PyPI第三方库


热门话题
用于批量操作的java RESTful API分块响应   java读取在线存储的文本文件   在Java ME中将双精度舍入到小数点后5位   java查找一个数字的最接近因子   java更改JMenuBar的字体   java Kmeans聚类算法运行时间和复杂性   java是否可以阻止try catch返回null   java内容解析器指向具有正确URI的错误表   java Android Kotlin插装测试未被识别为插装测试   java TestNG@Dataprovider   在forloop和print语句中声明变量时发生java错误   java在Android Studio 3中设置JNI