Document functions from different modules using pdoc

Question

I've got two modules:

first_module containing functions a, b and c

second_module containing functions d, e and f

I would like to generate an HTML documentation using pdoc such that it doesn't document both modules in whole, but rather contains only functions b, e, and f.

Any ideas?

Answer 1

You can declare __all__ in your modules as pdoc respects it.

Alternatively, you can override some docstrings with a __pdoc__ dict in each module:

# first_module.py:
___pdoc___ = {
    'a': False,
    'c': False,
}

and:

# second_module.py:
___pdoc___ = {
    'd': False,
}