Make plugin list in PDF docs readable#9241
Conversation
The current PDF docs attempt to format the list of all plugins as a table, without any word-wrapping of the plugin description. That results in almost all the information getting cut off. This PR formats the same information into more of a paragraph format for the PDF, with nothing cut off. Fixes pytest-dev#451
|
Sample output, starting on page 126: |
bluetech
left a comment
There was a problem hiding this comment.
Thank you, this looks good to me.
It would have been nice if there were some "responsive" table format, i.e. one that could self-adjust to the page dimensions, but I guess there isn't?
|
With sphinx, there is a way to set automatic width with wrapping for a column, but when the table has more than 30 rows, sphinx flips over to using the LaTeX With Another alternative I considered, before going with this PR, is to flip the pages with the table to landscape mode, possibly with a larger page size for just those pages. |
93ee6bd to
3ff2d80
Compare
for more information, see https://pre-commit.ci
|
OK, that sounds good! |
This is an impovement for a doc update introduced in this release, so including it in a changelog against the last release seems confusing. The issue number also seems about something different.
* Remove changelog entry for #8251 Reverted in #8903 * Move #9202 changelog to to trivial This won't concern users of pytest * Streamline deprecation changelogs/docs * Remove #8994 changelog This is an impovement for a warning introduced in this release, so including it in a changelog against the last release seems confusing. * Remove #9241 changelog This is an impovement for a doc update introduced in this release, so including it in a changelog against the last release seems confusing. The issue number also seems about something different. * Remove #8897 changelog Empty file... * Various minor changelog fixes
|
@andrewdotn I wonder if you have any ideas to make this table render better? This is what it looks like to me in Chrome browser / macOS - "last release" column way too narrow, and there's a lot of wrapping with hyphenation characters for some reason rendering as a box. Maybe the "status" and/or "requires" column(s) could be dropped, they don't have much useful info and it would allow the others to be wider. |

The current PDF docs attempt to format the list of all plugins as a
table, without any word-wrapping of the plugin description. That results
in almost all the information getting cut off. This PR formats the same
information into more of a paragraph format for the PDF, with nothing
cut off.