Automatically generate per-submodule API reference doc pages in template

オープン
  • 何か問題がありますか？
#573 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
45/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
python
領域
documentation

調査の方向性

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.

索引モデルが issue の本文から書いたものです。

説明

enhancement
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

主要言語
Python
スター
62
フォーク
10
平均マージ
5日 19時間
マージ済み PR（30日）
6

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

UCL-ARC/python-tooling のほかの issue

UCL-ARC/python-tooling の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。