UCL-ARC / UCL-ARC/python-tooling

Automatically generate per-submodule API reference doc pages in template

Open
#573 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
62
Forks
10
Avg merge
7d 6h
Merged PRs (30d)
6

Description

Is Your Feature Request Related to a Problem? Please Describe

Currently the mkdocstrings configuration for the MkDocs docs in the template

https://github.com/UCL-ARC/python-tooling/blob/f1a228d564614619b61e3783f7527b5b5672efb6/%7B%7Bcookiecutter.project_slug%7D%7D/mkdocs.yml#L46-L55

is set up to show submodules on the same page as the parent package, with a single 'API reference' page included in the docs

https://github.com/UCL-ARC/python-tooling/blob/f1a228d564614619b61e3783f7527b5b5672efb6/%7B%7Bcookiecutter.project_slug%7D%7D/docs/api.md?plain=1#L1-L3

While this works reasonably for small packages, once packages start getting larger it gets cumbersome to have all the API documentation on a single page.

In Sphinx the analagous autodoc plug-in instead defaults to creating a nested directory structure in the built docs reflecting the package structure with one page per submodule and appropriate indices to link all the nav together.

This can be achieved manually in our current set up by setting show_submodules to False, creating a Markdown source page for each submodule with the appropriate content, and adding entries to the nav section for each of the module pages but this is obviously very error prone / likely to end up getting out of sync.

Describe the Solution You'd Like

The mkdocstrings docs has instructions for setting up a recipe to automate building the appropriate module stub pages using mkdocs_gen_files plug-in and generating the navigation structure using mkdocs-literate-nav - ideally we should implement this in the template.

Describe Alternatives You've Considered

No response

Additional Context

No response

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the template's {{cookiecutter.project_slug}}/mkdocs.yml and docs/api.md, then read the linked mkdocstrings recipe for automatic code reference pages. Check how mkdocs_gen_files and mkdocs-literate-nav fit the template's existing configuration. Done means generated docs provide per-submodule API pages and navigation without manually maintained stubs.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.