Hello, I'm trying to use Sphinx to automatically generate documentation for a command line tool written in Python using Click. I'm using the sphinx-click <https://github.com/click-contrib/sphinx-click> plugin for this, but I'm having trouble figuring out how to cross-reference specific types of functions - namely commands and command groups.
I can reference options using :option:`group_name-command_name -option_name`, and I can reference environment variables using :ref:`DisplayText <group-command-option-envvar>` (doesn't seem to work without supplying a name, as written here <https://github.com/click-contrib/sphinx-click/issues/92>), but despite doing much trial and error I can't find how to reference command or command groups. The only solution I've found is HTML-specific, by using a direct link like `DisplayText <group-page.html#group-command>`_ - or `DisplayText <#group-command>`_ if it's on the same page - but that's obviously not a very good solution. Seeing as the table of contents entry does reference these things, I figure there's got to be a way to get these references, so I'm hoping someone here might have an answer for me. Being able to read the .doctree files to see what all the label names are might be enough, but I don't know how to do that either. Any help would be appreciated. Thanks in advance! Disclaimer The information contained in this communication from the sender is confidential. It is intended solely for use by the recipient and others authorized to receive it. If you are not the recipient, you are hereby notified that any disclosure, copying, distribution or taking action in relation of the contents of this information is strictly prohibited and may be unlawful. This email has been scanned for viruses and malware, and may have been automatically archived by Mimecast Ltd, an innovator in Software as a Service (SaaS) for business. Providing a safer and more useful place for your human generated data. Specializing in; Security, archiving and compliance. To find out more visit the Mimecast website. -- You received this message because you are subscribed to the Google Groups "sphinx-users" group. To unsubscribe from this group and stop receiving emails from it, send an email to sphinx-users+unsubscr...@googlegroups.com. To view this discussion on the web visit https://groups.google.com/d/msgid/sphinx-users/0e383cdc-06ec-4327-8ec4-6b8213daee4bn%40googlegroups.com.
