-
-
Notifications
You must be signed in to change notification settings - Fork 16.6k
Update installation instructions for Windows PowerShell #5831
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
base: main
Are you sure you want to change the base?
Conversation
Added instructions for enabling PowerShell script execution on Windows.
docs/installation.rst
Outdated
Your shell prompt will change to show the name of the activated | ||
environment. | ||
|
||
In windows, PowerShell scripts such as the venv activation script are blocked by default. To fix this, you should open PowerShell and run the command Set-ExecutionPolicy AllSigned or another policy that allows PowerShell scripts. Learn more at https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.security/set-executionpolicy?view=powershell-7.5 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I can't comment on whether this makes sense since I'm, not very familiar with PowerShell, but this line is excessively long compared to any other lines in this file.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Made it ever so slightly shorter, but wasn’t quite sure how to shorten it by a large amount
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I was talking about adding linebreaks, not actually shortening the content ;)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also, being a rst file, links should be correctly marked as links and not just plaintext urls. You can check other links in the same file for examples on how that's done.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I’ve added line breaks, but I’ve never used rst before and can’t figure out how to do the links…
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Figured them out now, I was using the wrong type of apostrophe 🤦
Reword PowerShell script execution policy instructions for length
Split the PowerShell script execution policy instructions into separate lines for better readability.
Updated the link format for PowerShell execution policy documentation.
Just checked my build and the link is broken... |
Fixed! Silly missing underscores. |
I don't think we need to go into this detail here. In fact, I really want to reduce this page, and point people at official docs for uv, virtualenv, etc instead. |
I’m not really sure how to link to that note in the docs as you have to scroll halfway down that page to actually find that note - it would probably be easier for a user to just read it straight from the flask docs, unless you can find a better link that I could use. |
Added instructions for enabling PowerShell script execution on Windows.