Use mkdocstrings for documenting Python code

オープン

#94 2022年8月18日に作成コメント 0 件リアクション 0 件担当者 0 名 GitHub で見る

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

評価

難易度: 5/5
見積もり時間: 1週間以上
初心者へのやさしさ: 30/100

issue の種類: 機能追加
明瞭さ: おおむね明確
活発さ: 停滞
技術スタック: python
領域: documentation

調査の方向性

Review the current manually maintained Python API documentation and the proposed mkdocstrings approach first. Check mkdocstrings/mkdocstrings#450 and #466 to determine whether the blockers are resolved. Done means the docs are generated from Python code, type hints, and docstrings without API-to-documentation mismatches.

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

説明

complexity: 3 (low) priority: 3 (low) type: docs

Current Situation

Currently, our Python APIs are manually added to the docs, which can potentially result in API <-> Docs mismatch.

Proposed Actions

Use mkdocstrings within the docs to automatically generate markdown based on Python code, type hints, and docstrings.

Implementing this is currently blocked by these issues:

mkdocstrings/mkdocstrings#450
mkdocstrings/mkdocstrings#466

主要言語: Python
スター: 357
フォーク: 22
平均マージ: 10時間 31分
マージ済み PR（30日）: 2

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

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

reactive-python/reactpy-django のほかの issue

Add coverage tests オープン

complexity: 3 (low) priority: 3 (low) type: ci

難易度 3/5 1〜2日初心者へのやさしさ 45/100

reactive-python/reactpy-django#274 · 2024年12月13日に作成
Resolve `django_form` limitations オープン

complexity: 1 (high) priority: 1 (high)

難易度 5/5 1週間以上初心者へのやさしさ 25/100

reactive-python/reactpy-django#270 · 2024年12月7日に作成
Resolve `view_to_component` limitations オープン

complexity: 2 (medium) priority: 3 (low)

難易度 5/5 1週間以上初心者へのやさしさ 25/100

reactive-python/reactpy-django#269 · 2024年12月7日に作成
Resolve `view_to_iframe` limitations オープン

complexity: 2 (medium) priority: 3 (low)

難易度 5/5 1週間以上初心者へのやさしさ 25/100

reactive-python/reactpy-django#268 · 2024年12月7日に作成
`pyscript_router` component オープン

complexity: 1 (high) priority: 2 (moderate)

難易度 5/5 1週間以上初心者へのやさしさ 25/100

reactive-python/reactpy-django#248 · 2024年8月23日に作成

reactive-python/reactpy-django の issue をすべて見る

似ている issue

货币战争手改优先级配置缺少列表元素类型校验（P3）オープン

難易度 2/5 1〜3時間初心者へのやさしさ 78/100

syfoud/Simulated_Scepter#172 · 2026年9月22日に作成
A cancelled tests run makes the coverage comment workflow fail and reports it as a red check on main オープン

area: ci bug perceived difficulty: 3

難易度 2/5 1〜3時間初心者へのやさしさ 78/100

Nitjsefnie-Harness-Commons/daedalus#921 · コメント 1 件 · 2026年9月22日に作成
flan MMLU MultiChoiceRegexFilter raises IndexError on an all-empty capture tuple (bbh fix #4125 missed these copies) オープン

難易度 2/5 1〜3時間初心者へのやさしさ 86/100

EleutherAI/lm-evaluation-harness#4207 · 2026年9月22日に作成
sync-plugin-skill.sh hardcodes python3 at line 75 and exits 127 on Windows オープン

難易度 1/5 1時間未満初心者へのやさしさ 92/100

conorbronsdon/avoid-ai-writing#333 · 2026年9月22日に作成
Avoid blocking async external-data uploads while preserving retries オープン

難易度 2/5 1〜3時間初心者へのやさしさ 78/100

ClickHouse/clickhouse-connect#1057 · 2026年9月22日に作成

Python の issue をもっと見る