Each of your classes and functions, both in and outside of classes, needs to have a docstring *in the code*as below, then help will do it's magic:
class SomeClass():
""" Documentation at a high level about the class """
def ClassMethod():
""" Documentation about class method """
# Actual Code
Copied from Comments:
the thing is that all of my classes and methods already HAVE docstrings as you described. E.g., when I call help(pdbsr.NewPdb) everything is fine for this class, but the Class does not show up in the general help(pdbsr) - this is what bothers me – Sebastian Raschka
Have you tried having an __all__ = ["package_item", ] in __init__.py files rather than from ???? import * statements?
yes, I tried it first and really couldn't get it to work with all = [...] - I don't know why. My goal is that all classes and functions should be available as e.g., pdbsr.function() without using more than 1 dot notation for the sub-packages. How would you do that with all considering my folder structure? I also tried to use an all in the __init__ files of the subpackages, but for some reason I couldnt get it to work :(
I think - from looking at help out put you need to have in each of the submodules __init__.py an '__all__ = [...]' where the ... is replaced with a comma separated list of quoted names of what it include from that module in the case of a 'from module import *' - when I first started using modules I missed that it was a list of names not a list of objects.