Skip to content

Commit 53bc4bc

Browse files
Update requirements.txt (#780)
* Update requirements.txt with commented procedures for our internal doc team. Co-authored-by: Anastasia Alexandrova <[email protected]>
1 parent 87cd686 commit 53bc4bc

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

requirements.txt

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,13 @@
1-
# This file is used to install the required packages for the project.
1+
# This file is used to install the required packages for the doc project.
2+
# Ensure you are in the same location/root that the requirements.txt file is in.
3+
# It is recommended to use Windows Powershell in Administrator mode or Linux Terminal to run the commands.
24
# You can install the required packages using the following command:
3-
# pip install <plugin_name>. Example: pip install mkdocs-material
5+
# pip install -r requirements.txt
6+
# This will install all the packages listed in this file.
7+
# To update the packages, run the following command:
8+
# pip install --upgrade -r requirements.txt
9+
# To check for outdated packages, run the following command:
10+
# pip list --outdated
411
Markdown
512
mkdocs
613
mkdocs-versioning
@@ -19,9 +26,3 @@ mike
1926
Pillow > 10.1.0
2027
mkdocs-open-in-new-tab
2128
mkdocs-print-site-plugin
22-
# To update the packages, run the following command in your terminal:
23-
# pip install --upgrade -r requirements.txt
24-
# To freeze the current packages and their versions, run the following command in your terminal:
25-
# pip freeze > requirements.txt
26-
# To check for outdated packages, run the following command in your terminal:
27-
# pip list --outdated

0 commit comments

Comments
 (0)