click-contrib / sphinx-click

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

Sphinx_click not working with Read The Docs #122

Closed Yarroudh closed 1 year ago

Yarroudh commented 1 year ago

I'm trying to create documentation for a CLI application using sphinx_click. When I build the docs locally using RDT template, I can see the CLI commands with their parameters, options and arguments but once I compile the docs in Read The Docs, the commands do not appear, all I have is an empty page with the header.

stephenfin commented 1 year ago

You need to enable installing the package under test. The RTD documentation has a guide for this.

Yarroudh commented 1 year ago

Thanks for your response. I did this in the first place but the problem persists. As I noticed, readthedocs fails to install and import another dependency, which through an error and that's why my commands are not being parsed.