Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Requirements table in docs does not actually render #260

Closed
EFord36 opened this issue Aug 8, 2023 · 0 comments · Fixed by #261
Closed

Requirements table in docs does not actually render #260

EFord36 opened this issue Aug 8, 2023 · 0 comments · Fixed by #261
Labels
P: docs Problem with docformatter documentation U: low A relatively low urgency issue

Comments

@EFord36
Copy link
Contributor

EFord36 commented Aug 8, 2023

The docs at readthedocs do not have a rendered table for the requirements: see here:

Screenshot 2023-08-08 at 15 32 00

This is despite the 'csv-table' sphinx directive in requirements.rst which should produce a table. When trying to build that file with sphinx locally, it produces an error:

docformatter/docs/source/requirements.rst:153: ERROR: Error with CSV data in "csv-table" directive:
',' expected after '''

.. csv-table:: **PEP 257 Requirements Summary**
    :align: left
    :header: " ID", " Requirement", " Category", " Type", " Implemented"
    :quote: '
    :widths: auto
@github-actions github-actions bot added the fresh This is a new issue label Aug 8, 2023
@weibullguy weibullguy added P: docs Problem with docformatter documentation U: low A relatively low urgency issue and removed fresh This is a new issue labels Aug 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
P: docs Problem with docformatter documentation U: low A relatively low urgency issue
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants