Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

MkDocs documentation in template omits submodules #365

Closed
matt-graham opened this issue Apr 26, 2024 · 0 comments · Fixed by #379
Closed

MkDocs documentation in template omits submodules #365

matt-graham opened this issue Apr 26, 2024 · 0 comments · Fixed by #379
Labels
bug Something isn't working

Comments

@matt-graham
Copy link
Collaborator

Describe the Bug

MkDocs documentation in template doesn't include submodules of top-level package in API reference as we don't enable the show_submodules option.

To Reproduce

Create an instance of template, add a submodule to the package with a docstring, generate docs.

Expected Behaviour

Documentation generated for top-level package and all submodules.

Actual Behaviour

Only the definitions in top-level __init__.py file appear in API reference page.

Additional Context

- Cookiecutter version: 
- Operating system:
- Python version:
@matt-graham matt-graham added the bug Something isn't working label Apr 26, 2024
@matt-graham matt-graham changed the title A one-line description of your problem MkDocs documentation in template omits submodules Apr 26, 2024
@matt-graham matt-graham mentioned this issue Jun 4, 2024
Merged
matt-graham added a commit that referenced this issue Jun 4, 2024
@matt-graham
Enable show_submodules option in MkDocs config (#379)
c9ca3fb 
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)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug Something isn't working
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Enable show_submodules option in MkDocs config UCL-ARC/python-tooling
1 participant
@matt-graham