0

When I want to attach the docstrings from bar module in my documentation, I put

::: foo.bar

in the markdown file.

It attaches all the docstrings in the bar file - module docstring and Bar class docstrings. When I want to attach just Bar classes docstrings, the syntax is:

::: foo.bar.Bar

Now I'd like to reference only module docstring without the class. How can I do that?

DavidS1992
  • 823
  • 1
  • 8
  • 19

1 Answers1

0

Use the members option:

::: foo.bar
    options:
      members: no

See https://mkdocstrings.github.io/python/usage/#globallocal-options.

pawamoy
  • 3,382
  • 1
  • 26
  • 44