-
-
Notifications
You must be signed in to change notification settings - Fork 122
Description
Is your feature request related to a problem? Please describe.
There are certain circumstances where I only want to embed the args/returns, and no title/description/etc.
Describe the solution you'd like
The main concept here is the ability to enable/disable rendering for all major blocks.
Expand the current set of show settings (currently only show_root_heading and show_source) to also include the following:
show_titleshow_descriptionshow_parametersshow_returnsshow_raises
... and for classes:
show_method_titleshow_method_descriptionshow_bases
A nice to have bonus feature would be the ability to globally change these default values.
Describe alternatives you've considered
Could alternatively develop a use_template="path_to_template.html" variable that allows the user to select their own Jinja template for that one specific include tag to use.
This would require additional documentation as to what context variables are accessible within the jinja context.
I wouldn't advise doing this though, as it seems unnecessarily complex for most people who just wanna hide basic stuff without changing the core rendering behavior.
Additional context
N/A