conda/conda-build

Implement sphinx-argparse for conda-build

オープン

#4,445 opened on 2022/04/26

GitHub で見るコントリビューターガイド
 (3 件のコメント) (1 件のリアクション) (0 人の担当者)Python (499 件のフォーク)auto 404
good first issuesource::anacondastale::recoveredtype::documentation

Repository metrics

Stars
 (399 個のスター)
PR merge metrics
 (平均マージ 5d 10h) (30d で 17 merged PRs)

説明

The commands that are documented here:

https://docs.conda.io/projects/conda-build/en/latest/resources/commands/index.html

are out of date with the documentation a user sees when they run conda build --help.

This happens because the command documentation is currently hard-coded. In order to fix this, we need to copy the method conda uses and create the documentation dynamically using the sphinx-argparse plugin.

This issue relates to the following issue:

コントリビューターガイド

調査方針
conda が sphinx argparse を使用してコマンドドキュメントを動的に生成する方法を調査し、同じアプローチを conda build に適用するためにプラグインを追加し、ドキュメント生成スクリプトを更新します。
技術スタック
python
領域
documentationcli
Issue 種別
機能
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-2日
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
PythonGitSphinx
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
70