sphinx-argparse icon indicating copy to clipboard operation
sphinx-argparse copied to clipboard

support reading Argparse instances inside classes

Open laf0rge opened this issue 7 months ago • 1 comments

So far, shphinxarg only has support for reading/importing Argparse instances from global variables/attributes within a module. However, there are use cases where Argparse is used inside classes of a module, not as a global variable. This is particularly the case for uses of 'argparse' in the context of CLI / REPL style user interfaces, such as for example those built using the 'cmd2' module.

This change introduces the ability to specify a path in ':func:' using the '.'-notation (e.g. 'PysimApp.bulk_script_parser').

Initial patch by: Harald Welte [email protected] Co-authored by: Vadim Yanitskiy [email protected]

This is a follow-up to https://github.com/sphinx-doc/sphinx-argparse/pull/36#event-13507765902

laf0rge avatar Jul 31 '24 18:07 laf0rge