Skip to content

Commit

Permalink
add requirements.txt for mkdocs
Browse files Browse the repository at this point in the history
  • Loading branch information
rxu17 committed May 17, 2024
1 parent 9ab7680 commit f05eea9
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 6 deletions.
11 changes: 5 additions & 6 deletions .github/workflows/build_docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,15 @@ jobs:
with:
python-version: 3.9

- name: Set Cache ID Based on UTC Week Number
run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV

- name: Cache dependences
uses: actions/cache@v3
with:
key: mkdocs-material-${{ env.cache_id }}
path: .cache
path: ~/.cache/pip
# Unique cache key based on requirements.txt in docs directory
key: ${{ runner.os }}-pip-${{ hashFiles('docs/requirements.txt') }}-mkdocs-deps
# Restore partial cache if exact match is not found
restore-keys: |
mkdocs-material-
${{ runner.os }}-pip-
- name: Install mkdocs and dependencies
run: |
Expand Down
5 changes: 5 additions & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
mkdocs<=1.6.0
mkdocs-material<=9.5.23
mkdocs-open-in-new-tab<=1.0.3
mkdocstrings<=0.25.1
mkdocstrings-python<=1.10.2

0 comments on commit f05eea9

Please sign in to comment.