Skip to main content

Sphinx CSV filter extension for Crate Documentation

Project description

A Sphinx plugin that extends the csv-table reStructuredText directive to add row filtering options.

Prerequisites

You need to be using Sphinx and reStructuredText.

Installation

The Sphinx CSV filter plugin is available as a pip package.

To install, run:

$ pip install sphinx-csv-filter

To update, run:

$ pip install -U sphinx-csv-filter

Set Up

To include the extension, add this line to config.py in your Sphinx project:

extensions = ['crate.sphinx.csv']

If you’re using other extensions, edit the existing list, or add this:

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

Use

This plugin adds the following options to the csv-table directive:

:included_cols:
This is a comma-separated list of column indexes to include in the output.
:include:
This option takes a Python dict specifying the column index (starting at zero) and a regular expression. Rows are included if the columnar value matches the supplied regular expression.
:exclude:
This option takes a Python dict specifying the column index (starting at zero) and a regular expression. Rows are excluded if the columnar value matches the supplied regular expression.

If a row matches an :include: as well as an :exclude: filter, the row with be excluded.

Here’s an example:

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

In this example, rows from example.csv will be omitted from the output if the regular expression (?i)Y\w* matches value of the Attend? column.

Contributing

This project is primarily maintained by Crate.io, but we welcome community contributions!

See the developer docs and the contribution docs for more information.

Help

Looking for more help?

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for sphinx-csv-filter, version 0.3.0
Filename, size File type Python version Upload date Hashes
Filename, size sphinx_csv_filter-0.3.0-py2.py3-none-any.whl (9.2 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size sphinx-csv-filter-0.3.0.tar.gz (5.7 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page