Docs or man page?

[gingerbeardman]

Is your feature request related to a problem? Please describe. Since v3 i find it troublesome to remember the command line usage and am forever looking things up

Describe the solution you'd like

• Docs or man page would be great
• Even better if it can be generated from the source

Could be one of the following formats

• man
• Sphinx (most common for Python projects)
• HTML (generated from Sphinx, I generated my own for aubio)

Describe alternatives you've considered (if relevant)

• Generate my own docset somehow (no success so far)
• https://github.com/arkrow/PyMusicLooper/blob/master/CLI_README.md

Additional context

• I use the Dash doc reader app on macOS. It has equivalents on Linux/Windows.

[arkrow]

Having a docs page would be great. I've actually looked through several tools previously, but they always had some quirk/annoyance, then unfortunately I got busy and never really continued working on it. Instead, I ended up doing CLI_README.md as a stopgap solution. Due to my use of rich-click for nicer CLI rather than the base click library, either the --help view of each subcommand comes out formatted strangely, and/or the help text includes the rich markup, which would would need post-processing to remove.

That said, I'm still interested in doing proper documentation for the project, so I'll be picking it back up once I can.

[gingerbeardman]

Thank you kindly!

For reference, perhaps it will influence your decisions, Dash the docset viewer I use accepts a number of formats: https://kapeli.com/docsets