conda/conda-build

Implement sphinx-argparse for conda-build

Open

#4,445 opened on Apr 26, 2022

View on GitHub
 (3 comments) (1 reaction) (0 assignees)Python (499 forks)auto 404
good first issuesource::anacondastale::recoveredtype::documentation

Repository metrics

Stars
 (399 stars)
PR merge metrics
 (PR metrics pending)

Description

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:

Contributor guide

Research direction
Investigate how conda uses sphinx argparse to dynamically generate command documentation, then apply the same approach to conda build by adding the plugin and updating the documentation generation script.
Tech stack
python
Domain
documentationcli
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonGitSphinx
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70