How to select specific classes and functions which should be included in resulting file

[PJ-Schulz]

When I create the markdown file with this command: pydoc-markdown -I my-fancy-lib -m example > docs/example.md, i get a resulting example.md with the classes _Foo, Abc and Def.

1. How can I exclude classes of functions with a leading underscore?

   • When its currently not supported, would it make sense to add an option to include or exclude underlined objects?

2. How can I select the classes or functions which should be included? For example when I only want class Abc in the resulting example.md.

   • option to include or exclude objects from the module. For example -m example --include=Abc or -m example --exclude=_Foo --exclude=Def

From my example Bar is automaticly not included in example.md because there is no docstring. But maybe someone want add docstrings to function or classes in code for documentation, but want this class in the resulting markdown file.

This is my structure:

docs/
my-fancy-lib/
    example.py
...

Here is my example file:

class _Foo:
    """
    This is Foo
    """
    def __init__(self) -> None:
        """
        here is foo init
        """
        pass

class Bar:

    def __init__(self) -> None:
        pass


class Abc:
    """
    This is Abc
    """
    def __init__(self) -> None:
        """
        here is abc init
        """
        pass

class Def:
    """
    This is Def
    """
    def __init__(self) -> None:
        """
        here is def init
        """
        pass

[MaxLenormand]

We were looking into something similar

Were you able to find a solution to this?