-
-
Notifications
You must be signed in to change notification settings - Fork 1.9k
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
Document how to rename (move) project directory #5129
Comments
- Added documentation in installation.md under 'Virtualenv' mapping caveat - Added documentation to the virtualenv.md
Hi there! I had the same confusion and this thread and #5123 were helpful. I also looked for the answer the docs before I came to github issue page, so it does seem like it would be great to have the quick fix in the documentation. l looked at the contribution rules and only made a small change to the documentation. There were 2 spots where the behavior of virtualenv was touched on but maybe not as full explained in terms of how to handle moving a project folder. I basically tried to just place the explanation (given by @j-mo in issue #5123 ) into the documentation at these points. I made the section Virtualenv-mapping-caveat more explicit and added a heading under Virtualenv. But, I am a first-timer committer, so not sure if just editing the markdown files as I did was the change that is needed. |
- Added documentation in installation.md under 'Virtualenv' mapping caveat - Added documentation to the virtualenv.md
Is your feature request related to a problem? Please describe.
I am a developer with an existing project directory managed by pipenv. I want to move my project directory (rename the directory and/or move it to a different parent directory). This breaks the connection between the project directory and the environment directory.
The workaround is to remove the pipenv management of the project directory via
pipenv --rm
, then move or rename the project directory, then restore pipenv management viapipenv install
. (Source: answer to discussion #5123 "How do I rename or move a directory managed by pipenv?".)Describe the solution you'd like
A section of the documentation entitled, "How to rename or move the project directory", in either the Basics documentation (docs/basics.rst) or Advanced documentation (docs/advanced.rst). A few sentences should be enough to describe the method. The title should attract the attention of a developer wanting to rename their project directory and wondering how to do it right.
Also describe what a developer should do who has renamed their directory, discovered that things have broken, and who wants to recover.
Describe alternatives you've considered
The Install documentation section, ''Virtualenv mapping caveat'', does say,
This is clearly relevant, but also when I had the question, I could not find the answer here. Thus I think this information belongs in Basics or Advanced, with a clearly relevant heading, instead.
Additional context
Related issues:
I am running pipenv 2022.5.2 on macOS Monterey 12.4.
The text was updated successfully, but these errors were encountered: