用于板条箱文档的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中的行。