Skip to content

Display env vars for pip options in docs #11993

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

Closed
wants to merge 1 commit into from
Closed

Conversation

ctg123
Copy link
Contributor

@ctg123 ctg123 commented Apr 22, 2023

Ref #8044

@uranusjr
Copy link
Member

uranusjr commented Apr 24, 2023

Need to fix errors in CI. I also wonder there should be a link to the environment variable documentation. https://pip.pypa.io/en/stable/topics/configuration/#environment-variables


Example rendering, for reviewers: https://pip--11993.org.readthedocs.build/en/11993/cli/pip_install/#options

@pradyunsg
Copy link
Member

I also wonder there should be a link to the environment variable documentation. pip.pypa.io/en/stable/topics/configuration/#environment-variables

Let's get this landed, and then we can improve this in a follow up! :)

@pradyunsg
Copy link
Member

@ctg123 Could you look into the code style checks mentioned in https://results.pre-commit.ci/run/github/1446467/1682204558.lnkhmFhyTr-BUqnOYSGFmw?

You can run those checks locally as documented in https://pip.pypa.io/en/stable/development/getting-started/#running-linters

@ctg123
Copy link
Contributor Author

ctg123 commented May 8, 2023

Hi all, OK I will look into running the CI tests this week.

@webknjaz
Copy link
Member

@ctg123 looks like beside autoformatting, you'd need to add some typing as well. But feel free to add separate commits, one fix at a time if that's easier.

@webknjaz webknjaz added the type: docs Documentation related label Mar 1, 2024
@webknjaz

This comment was marked as outdated.

@webknjaz
Copy link
Member

webknjaz commented Mar 1, 2024

Context: this PR was created during https://us.pycon.org/2023/events/mentored-sprints/. It may need somebody to take over and polish the types for linting to pass. This can be done through a separate PR — somebody would need to git fetch https://github.com/ctg123/pip/tree/docs-envvars.git in their fork and then do something like git checkout -b maintenance/11993/docs-env-vars-rendering docs-envvars to get the original commits from this PR and make another branch+PR with those included.

@webknjaz webknjaz added the good first issue A good item for first time contributors to work on label Mar 1, 2024
@luismedel
Copy link
Contributor

luismedel commented Mar 14, 2024

Context: this PR was created during https://us.pycon.org/2023/events/mentored-sprints/. It may need somebody to take over and polish the types for linting to pass. This can be done through a separate PR — somebody would need to git fetch https://github.com/ctg123/pip/tree/docs-envvars.git in their fork and then do something like git checkout -b maintenance/11993/docs-env-vars-rendering docs-envvars to get the original commits from this PR and make another branch+PR with those included.

@webknjaz I created a new PR including this and the missing changes.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 1, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
good first issue A good item for first time contributors to work on type: docs Documentation related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants