-
-
Notifications
You must be signed in to change notification settings - Fork 2.3k
Closed as not planned
Closed as not planned
Copy link
Labels
Description
Describe the bug
For a valid csv table like
.. csv-table::
:header: "Operation", "0.11.0 (ms)", "Prior Version (ms)", "Ratio to Prior"
:widths: 25, 25, 25, 25
:delim: ;
``df1 > df2``; 13.32; 125.35; 0.1063
``df1 * df2``; 21.71; 36.63; 0.5928
``df1 + df2``; 22.04; 36.50; 0.6039
When building with warnings (-W
) in sphinx 7.3, this outputs Error with CSV data in "csv-table" directive: ';' expected after '"'
How to Reproduce
source/index.rst
.. test documentation master file, created by
sphinx-quickstart on Wed Apr 17 10:51:37 2024.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to test's documentation!
================================
.. toctree::
:maxdepth: 2
:caption: Contents:
.. csv-table::
:header: "Operation", "0.11.0 (ms)", "Prior Version (ms)", "Ratio to Prior"
:widths: 25, 25, 25, 25
:delim: ;
``df1 > df2``; 13.32; 125.35; 0.1063
``df1 * df2``; 21.71; 36.63; 0.5928
``df1 + df2``; 22.04; 36.50; 0.6039
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
source/conf.py
# Configuration file for the Sphinx documentation builder.
#
# For the full list of built-in configuration values, see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
project = 'test'
copyright = '2024, me'
author = 'me'
release = '1.0'
# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
extensions = []
templates_path = ['_templates']
exclude_patterns = []
# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
html_theme = 'alabaster'
html_static_path = ['_static']
(sphinx-test) ... ~ % sphinx-build -b html -W source tmp_dir
Running Sphinx v7.3.5
building [mo]: targets for 0 po files that are out of date
writing output...
building [html]: targets for 1 source files that are out of date
updating environment: [new config] 1 added, 0 changed, 0 removed
reading sources... [100%] index
Warning, treated as error:
.../source/index.rst:14:Error with CSV data in "csv-table" directive:
';' expected after '"'
.. csv-table::
:header: "Operation", "0.11.0 (ms)", "Prior Version (ms)", "Ratio to Prior"
:widths: 25, 25, 25, 25
:delim: ;
``df1 > df2``; 13.32; 125.35; 0.1063
``df1 * df2``; 21.71; 36.63; 0.5928
``df1 + df2``; 22.04; 36.50; 0.6039
Environment Information
Platform: darwin; (macOS-12.7.4-arm64-arm-64bit)
Python version: 3.12.3 | packaged by conda-forge | (main, Apr 15 2024, 18:35:20) [Clang 16.0.6 ])
Python implementation: CPython
Sphinx version: 7.3.5
Docutils version: 0.21.1
Jinja2 version: 3.1.3
Pygments version: 2.17.2
Sphinx extensions
None
Additional context
This works fine in sphinx 7.2
(sphinx-test) ... ~ % sphinx-build -b html -W source tmp_dir
Running Sphinx v7.2.6
building [mo]: targets for 0 po files that are out of date
writing output...
building [html]: targets for 1 source files that are out of date
updating environment: [new config] 1 added, 0 changed, 0 removed
reading sources... [100%] index
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
copying assets... copying static files... done
copying extra files... done
done
writing output... [100%] index
generating indices... genindex done
writing additional pages... search done
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded.
The HTML pages are in tmp_dir.