Try `show_submodules: true` in all modules
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 29
- Forks
- 9
- Avg merge
- 9d 9h
- Merged PRs (30d)
- 8
Description
Would something like result in not having to specify the submodules manually?
::: pyrenew
options:
show_submodules: true
for example, in https://github.com/CDCgov/PyRenew/blob/main/docs/reference/latent.md we have
# Latent
::: pyrenew.latent
## Temporal Processes
::: pyrenew.latent.temporal_processes
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with docs/reference/latent.md and compare its explicit pyrenew.latent and pyrenew.latent.temporal_processes directives with the proposed show_submodules: true option. Check the other module reference pages and determine whether enabling the option removes the manual submodule entries without losing needed documentation coverage; done means the module pages build correctly with the simplified directives.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100