From c9ca3fb6ebc68bf78ee135fc0801b12f3ab122d2 Mon Sep 17 00:00:00 2001
From: Matt Graham <matthew.m.graham@gmail.com>
Date: Tue, 4 Jun 2024 10:40:05 +0100
Subject: [PATCH] Enable `show_submodules` option in MkDocs config (#379)

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)
---
 {{cookiecutter.project_slug}}/mkdocs.yml | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/{{cookiecutter.project_slug}}/mkdocs.yml b/{{cookiecutter.project_slug}}/mkdocs.yml
index 36b2bb3f..34ef17e7 100644
--- a/{{cookiecutter.project_slug}}/mkdocs.yml
+++ b/{{cookiecutter.project_slug}}/mkdocs.yml
@@ -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: "{!"