conda/conda-build

Implement sphinx-argparse for conda-build

Aperta

#4445 aperta il 26 apr 2022

Vedi su GitHubGuida contributor
 (3 commenti) (1 reazione) (0 assegnatari)Python (499 fork)auto 404
good first issuesource::anacondastale::recoveredtype::documentation

Metriche repository

Star
 (399 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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:

Guida contributor

Direzione di ricerca
Investiga come conda utilizza sphinx argparse per generare dinamicamente la documentazione dei comandi, quindi applica lo stesso approccio a conda build aggiungendo il plugin e aggiornando lo script di generazione della documentazione.
Tech stack
python
Dominio
documentationcli
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
PythonGitSphinx
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70