click-contrib / sphinx-click

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

sphinx-click fails to show options #89

Closed ShervinAbd92 closed 2 years ago

ShervinAbd92 commented 2 years ago

Hi, I have a click-based command-line interface python package and i would to show all the options as a commandline options together in my documentation, currently i have the following setup

.. click:: fcdproc.cli:fcdproc 
   :prog: fcdproc
   :nested: full

but get the bellow in my documentation:

file:///Users/abdollahis2/github/ShervinAbd92/fcdproc/docs/build/html/usage.html

I would like to get a documentation description like the fmirprep :

https://fmriprep.org/en/stable/usage.html

Is this feasible with sphinx-click module?

ShervinAbd92 commented 2 years ago
Screen Shot 2021-12-28 at 8 31 44 AM
stephenfin commented 2 years ago

I'm sorry, I don't understand the question. Can you rephrase it?