Add pip requirements file, update scripts
MODIFY
.github/workflows/deploy-doc-site.yml
.github/workflows/deploy-doc-site.yml
@@ -53,7 +53,7 @@ jobs:
- name: Install Python dependencies
run: |
python -m pip install --upgrade pip
- pip install mkdocs mkdocs-material mkdocs-redirects
+ pip install -r requirements.txt
# This environment variable step should be run after all 3rd-party actions to ensure nothing
# else accidentally overrides any of our special variables.

MODIFY
.github/workflows/validate-documentation.yml
.github/workflows/validate-documentation.yml
@@ -25,7 +25,7 @@ jobs:
- name: Upgrade pip
run: python -m pip install --upgrade pip
- name: Install dependencies
- run: pip install mkdocs-material mkdocs-redirects
+ run: pip install -r requirements.txt
- name: Run mkdocs
run: mkdocs build

MODIFY
RELEASING.md
RELEASING.md
@@ -150,11 +150,11 @@ an error about Catalyst and only empty READMEs will get generated.
#### mkdocs
-Mkdocs is written in Python, so you'll need Python and pip in order to run it. Assuming those are
+Mkdocs is written in Python, so you'll need Python 3 and pip in order to run it. Assuming those are
set up, run:
```bash
-pip install mkdocs mkdocs-material mkdocs-redirects
+pip install -r requirements.txt
```
Generate the site manually with:

MODIFY
deploy_website.sh
deploy_website.sh
# The website is built using MkDocs with the Material theme.
# https://squidfunk.github.io/mkdocs-material/
-# It requires Python to run.
+# It requires Python 3 to run.
# Install the packages with the following command:
-# pip install mkdocs mkdocs-material mkdocs-redirects
+# pip install -r requirements.txt
# Preview the site as you're editing it with:
# mkdocs serve
# It also uses CocoaPods and Sourcedocs to build the Swift docs.

ADD
requirements.txt
+mkdocs==1.1
+mkdocs-material==4.6.3
+mkdocs-redirects==1.0.0

Add pip requirements file, update scripts