pdoc3 / pdoc

:snake: :arrow_right: :scroll: Auto-generate API documentation for Python projects
https://pdoc3.github.io/pdoc/
GNU Affero General Public License v3.0
1.12k stars 145 forks source link

[Question] Is there any way to turn off specific functionality? #351

Closed zerosheepmoo closed 3 years ago

zerosheepmoo commented 3 years ago

I hope there is an option to turn off specific functionality, such as inherited_members. I cannot discover the way to do it in the official documents. Sometimes, people don't want to know too specific hierarchy, only desire simple skeleton of certain classes or methods. This can occur when using 3rd party libs already documented well and when I extend the class of it.

By the way, I couldn't find the discussion community, so I've asked here. If there is someone who knows such channel, let me know.

+added) I know pdoc3 provides __pdoc__ overriding. But that is quite limited, and to achieve the goal, too many configurations required.

Additional info

kernc commented 3 years ago

I hope there is an option to turn off specific functionality, such as inherited_members.

Pdoc3 uses config.mako template as the configuration file. You can provide your custom config.mako and run with --template-dir, or override individual configuration options with --config, e.g. pdoc --config show_inherited_members=False my_project.

Since show_inherited_members=False is the default, I suspect you mean to hide "Inherited members" list completely. Unfortunately, this is part of the default html.mako template and you'd need to modify it yourself. https://github.com/pdoc3/pdoc/blob/f358893e4fcfd7f29857a7ff5491b606ff146d39/pdoc/templates/html.mako#L251-L270

zerosheepmoo commented 3 years ago

THANKs!