crate / crate/sphinx-csv-filter

Incompatibility with docutils 0.21 and 0.22

Open
#52 4 comments 0 reactions 0 assignees View on GitHub
bug dependencies
Dominant language
Python
Stars
8
Forks
5
PR merge metrics
No merged PRs in 30d

Description

## Problem
The `sphinx-csv-filter` addon currently has problems with docutils 0.21. In crate/crate, appendices/compliance.rst:6, an exception is raised:
```
ERROR: One or more indexes of included_cols are not valid. The CSV data does not contain that many columns. [docutils]
```

## Workaround
Downgrade to docutils 0.20 until the problem has been resolved.

## References
- https://github.com/crate/crate/blob/master/docs/appendices/compliance.rst?plain=1#L23-L29
- https://github.com/crate/crate/blob/master/server/src/main/resources/sql_features.tsv
- https://github.com/crate/crate/pull/18862
- https://github.com/crate/crate/pull/18999

Contributor guide

Open the contributing guide

Research direction

Start by reproducing the failure described at crate/crate's docs/appendices/compliance.rst:6 and inspect the referenced server/src/main/resources/sql_features.tsv and linked pull requests for the changed CSV shape. Done means the sphinx-csv-filter addon works with docutils 0.21 and 0.22 without the included_cols exception, while retaining compatibility with 0.20.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.