Request for short clarification on design principles

[1kastner]

Description

Other modules, such as https://github.com/agronholm/sphinx-autodoc-typehints, also extend the options of the sphinx documentation. However, they do not use decorators in the code. Instead, they listen to sphinx events. This way, only the people who build the docs need to have the module installed. When using the decorator approach like in this module, each user needs to install it just to run the code. Furthermore, the decorators are invoked every time the the module is imported, even if it is only used programmatically and no documentation is required. What were the reasons that led to this decorator-based module design? A small explanation in the Readme would be very great! Thank you very much for the clarification.

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[1kastner]

@domdfcoding did you find some time to have a look at this?

[1kastner]

I would favor if the decorator only turned active while the documentation is generated. Could it be a no-op while the actual program runs?

[1kastner]

@domdfcoding any chance?