Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement sphinx-argparse for conda-build #4445

Open
travishathaway opened this issue Apr 26, 2022 · 3 comments
Open

Implement sphinx-argparse for conda-build #4445

travishathaway opened this issue Apr 26, 2022 · 3 comments
Labels
good first issue great for new contributors, code change is envisioned to be trivial/relatively straight-forward source::anaconda created by members of Anaconda, Inc. stale::recovered [bot] recovered after being marked as stale type::documentation request for improved documentation

Comments

@travishathaway
Copy link
Contributor

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:

@travishathaway travishathaway added source::anaconda created by members of Anaconda, Inc. type::documentation request for improved documentation good first issue great for new contributors, code change is envisioned to be trivial/relatively straight-forward labels Apr 26, 2022
@github-actions
Copy link

Hi there, thank you for your contribution!

This issue has been automatically marked as stale because it has not had recent activity. It will be closed automatically if no further activity occurs.

If you would like this issue to remain open please:

  1. Verify that you can still reproduce the issue at hand
  2. Comment that the issue is still reproducible and include:
    - What OS and version you reproduced the issue on
    - What steps you followed to reproduce the issue

NOTE: If this issue was closed prematurely, please leave a comment.

Thanks!

@github-actions github-actions bot added the stale [bot] marked as stale due to inactivity label Jun 29, 2023
@jezdez
Copy link
Member

jezdez commented Jun 30, 2023

Still a thing

@github-actions github-actions bot added stale::recovered [bot] recovered after being marked as stale and removed stale [bot] marked as stale due to inactivity labels Jul 1, 2023
@PatSunter
Copy link

Is this issue now deprecated by #5235 ?

I.E. if Conda has split out conda-index into a separate project and tool that has to be invoked differently anyway now?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue great for new contributors, code change is envisioned to be trivial/relatively straight-forward source::anaconda created by members of Anaconda, Inc. stale::recovered [bot] recovered after being marked as stale type::documentation request for improved documentation
Projects
Status: No status
Development

No branches or pull requests

3 participants