docs: split CLI args in HTML output into rows#3379
Conversation
instead of separating them with a comma, so that it adds anchors to secondary arguments. The rendered manpage already splits arguments into multiple rows if there are multiple arguments for a specific command. Fix CSS of the rtd_theme_violet theme and hide empty argument values.
|
This is cherry-picked from the furo-theme PR, with fixes for the current theme. The CSS fixes are rather ugly, but that's because of the layout of the docutils output and theme styling, and it's supposed to work everywhere. Btw, I'd love to split the CLI docs page into two pages:
The reason for this is that finding CLI arguments is always a bit annoying and you have to scroll down. On the current theme, this is especially a problem, because the individual CLI argument sections are not listed in a TOC menu, like on the furo theme. |
|
Just in case it's not clear what this change actually does: Previously:
After:
I'm aware that this may look a bit weird on the current theme due to the background+border style, but the arguments should not be separated with a comma here and putting two boxes on the same line is weird, because the anchors only appear on hover and hovering the first box would move the secondary or third boxes, which is bad. On the furo theme, this won't be a problem. |
instead of separating them with a comma, so that it adds anchors to secondary arguments. The rendered manpage already splits arguments into multiple rows if there are multiple arguments for a specific command. Fix CSS of the rtd_theme_violet theme and hide empty argument values. streamlink#3379
instead of separating them with a comma, so that it adds anchors to
secondary arguments. The rendered manpage already splits arguments into
multiple rows if there are multiple arguments for a specific command.
Fix CSS of the rtd_theme_violet theme and hide empty argument values.