search

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

enable showing private methods/variables #375

Open mkinney opened 2 years ago

mkinney commented 2 years ago

Expected Behavior

Would like to see private methods/variables in the documentation

Actual Behavior

Methods and variables that begin with "_" are excluded.

Steps to Reproduce

  1. Generate docs that have a private method.
  2. See that the private method does not show up

Additional info

If I change this line: https://github.com/mkinney/pdoc/blob/master/pdoc/__init__.py#L409

to this:

return not ident_name.startswith("__")

It does what I'd like to see.

Would it make sense to add a command line arg (or configuration setting) that would enable this?

luzpaz commented 1 year ago

bump

luzpaz commented 9 months ago

No response ?