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

Add missing comma in requirements table #261

Merged
merged 2 commits into from
Aug 9, 2023
Merged

Add missing comma in requirements table #261

merged 2 commits into from
Aug 9, 2023

Conversation

EFord36
Copy link
Contributor

@EFord36 EFord36 commented Aug 8, 2023

Closes #260

This caused Sphinx to fail to render the entire table.

After this change, the Sphinx error has gone away and the table renders:

Screenshot 2023-08-08 at 15 31 39

This caused Sphinx to fail to render the entire table.
@weibullguy weibullguy added P: docs Problem with docformatter documentation U: low A relatively low urgency issue labels Aug 8, 2023
@weibullguy
Copy link
Member

weibullguy commented Aug 9, 2023

@EFord36 would you be amenable to adding the following testenv for tox in pyproject.toml?


[testenv:docs]
description = build docformatter documentation
allowlist_externals = make
changedir = docs
commands =
    make html

Just add that between this line -> rstcheck --report-level=1 {toxinidir}/README.rst and the closing """ at the very end of the file. No worries if you don't want to, it just saves another PR. TIA

@EFord36
Copy link
Contributor Author

EFord36 commented Aug 9, 2023

sure, I'll look at that now. Thanks for letting me know the issue!

@EFord36
Copy link
Contributor Author

EFord36 commented Aug 9, 2023

@weibullguy I just pushed a new commit to the branch with that change - let me know if I've made any mistake, or you want any more explanation/detail in the commit message or anything!

@weibullguy
Copy link
Member

sure, I'll look at that now. Thanks for letting me know the issue!

Wasn't an issue, I was just trying to get you to do something I'd have to do later! 😉

@weibullguy weibullguy merged commit 5948f6d into PyCQA:master Aug 9, 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 this pull request may close these issues.

Requirements table in docs does not actually render
2 participants