search

click-contrib / sphinx-click

A Sphinx plugin to automatically document click-based applications
MIT License
212 stars 57 forks source link

WIP: Provide additional options information #16

Closed kvalev closed 4 years ago

kvalev commented 6 years ago

ref #6

kvalev commented 6 years ago

I want to add some additional documentation for the options parameter, but if I follow the existing pattern of formatting the help string, then it looks kinda messy, especially when there are multiple choices. Example:

Description here. [required; choice; one of: asd, qwe, asdasd, adsasdas, asdasd]

Do you have some ideas, how the options help section should look like?