Skip to content

Commit

Permalink
Enable show_submodules option in MkDocs config (#379)
Browse files Browse the repository at this point in the history
Fixes #365

Enables `plugins.mkdocstrings.handlers.python.options.show_submodules`
option in `mkdocs.yml` configuration file for template so that
[submodules of the top-level package are included in autogenerated API
reference documentation by
default.](https://stackoverflow.com/a/74237199)
  • Loading branch information
matt-graham authored Jun 4, 2024
1 parent cb06ee7 commit c9ca3fb
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions {{cookiecutter.project_slug}}/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,8 @@ plugins:
docstring_style: google
import:
- "https://docs.python.org/3/objects.inv"
options:
show_submodules: true
paths: [src]
- include-markdown:
opening_tag: "{!"
Expand Down

0 comments on commit c9ca3fb

Please sign in to comment.