Click sub-command name renaming not detected

[Querela]

Hi, I'm using the most current version of Sphinx (3.4.2), Sphinx-Click (latest) and click (7.1.2).

My situation is like this:

• I have a separate package with a click cli, which has a group named main (module modA.cli in package packageA)
• in another package (module modB.cli in package packageB) I also have a CLI and import the group main from modA.cli as submain
• I add the submain group to the modB.cli command groups as a subcommand.
  If I now execute packageB I will see the subcommand submain as possible choice. In the generated documentation it however will still appear as main (name from modA.cli I would suppose)

Not sure if the example code can reproduce this or if it has to be separate packages (not just modules)...

# packageA modA.cli

import click

@click.group()
def main():
    pass


@main.group()
def subA():
    pass

# packageB modB.cli

import click
from modA.cli import main as submain

@click.group()
def main():
    pass

main.add_command(submain, "submain")  # <-- here I add the commandgroup from packageB and rename the command
# without renaming here, it will show up as `main` in the CLI

@main.group()
def subB():
    pass

I will then call the modB.cli:main() entry point.

Documentation is dead simple:

.. click:: modB.cli:main
  :prog: packageB
  :nested: full

[stephenfin]

Yeah, this isn't something we currently support. I'm not sure how easy it would be to fix this since we don't fully evaluate the application.

[Querela]

Ok. That makes sense and it guards against some side effects.
Is it possible to manually rename the command in the docs? (Also complicated probably because of any possible depth.)

[stephenfin]

Unfortunately not, no

[Querela]

Hmm.
It's an internal project. And documentation is currently not done automatically. So maybe just manual postprocessing to update the 5-6 occurrences where it is wrong. Or just a notice somewhere.
I can't think of any easy solution/fix for now ...

[kaczmarj]

the renamed names are lost in these lines:

sphinx-click/sphinx_click/ext.py

Lines 285 to 288 in aa0d5b7

	if commands is None:
	return sorted(lookup.values(), key=lambda item: item.name)
	return [lookup[command] for command in commands if command in lookup]

prior to those lines, for a click.Group, lookup is a dictionary that maps the new names to the click.Command objects. those lines return a list that strips away the new names. perhaps the lookup can be maintained, and the commands can be ordered alphabetically using a OrderedDict (or a list of tuples).

this issue is preventing me from using sphinx-click to document my application.

[stephenfin]

I'd welcome a pull request to fix this. Please include tests