Is it possible to exclude a module for generating a html site?

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.14k stars 146 forks source link

Closed maiaalx closed 2 years ago

maiaalx commented 2 years ago

Hi together, i would like to exclude one module (module is not empty) for running pdoc --html Is there any command i could use?

Thank you in advance!

kernc commented 2 years ago

You could prepend module name with an underscore, thereby designating it private. Alternatively, you could set __pdoc__['module.name'] = False in some higher-level or top-level module to prevent pdoc from documenting that module.