rich-click
rich-click copied to clipboard
rich markup shows when using sphinx-click
Currently, the click-man-page rendering and sphinx html docs get pretty messed up when using rich-click. Here's an example of a man page output:
ISO(1) iso Manual ISO(1)
NAME
iso - Main Isomer CLI
SYNOPSIS
iso [OPTIONS] COMMAND [ARGS]...
DESCRIPTION
[bold cyan on blue] :diamonds: Isomer[/][white on blue] Management Tool [/]
This tool supports various operations to manage Isomer instances.
[yellow] :warning: Most of the commands are [u]grouped[/u].[/]
To obtain more information about the groups' available subcommands/groups, try:
[bright_cyan] iso [/]
To display details of a command or its subgroups, try:
[bright_cyan] iso [..] --help[/]
To get a map of all available commands, try:
[bright_cyan] iso cmdmap[/]
OPTIONS
-e, --env, --environment [blue|green|current|other]
Override environment to act on (CAUTION!)
Notice the --env
option - it is not immediately obvious if that is weird markup or actual option choices.
I think it would make sense to somehow throw all the markup out in manpages. With sphinx-generated html or similar things that could render them - not sure how to proceed.