Skip to content

Commit b12d325

Browse files
committed
fix(docs): move mkdocs requirements to file
mhausenblas/mkdocs-deploy-gh-pages pip installs the requirements.txt from the root of the repo unless overridden with another path there is currently no way to opt-out; this was under discussion in Dec 2020: mhausenblas/mkdocs-deploy-gh-pages#55 this is problem, we don't want to install requirements from benefits for mkdocs, so provide the REQUIREMENTS env with our mkdocs dependencies
1 parent a0d0274 commit b12d325

File tree

3 files changed

+12
-4
lines changed

3 files changed

+12
-4
lines changed

.github/workflows/mkdocs.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ jobs:
1616
- name: Deploy docs
1717
uses: mhausenblas/mkdocs-deploy-gh-pages@master
1818
env:
19-
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
19+
REQUIREMENTS: docs/requirements.txt
2020
CUSTOM_DOMAIN: docs.calitp.org
2121
CONFIG_FILE: docs/mkdocs.yml
22+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Dockerfile.dev

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@ FROM benefits_client:latest
22

33
USER root
44

5+
COPY docs/requirements.txt docs/requirements.txt
6+
57
RUN apt-get install -qq --no-install-recommends curl git jq ssh && \
6-
pip install --no-cache-dir flake8 debugpy pre-commit \
7-
mkdocs mkdocs-material mkdocs-awesome-pages-plugin \
8-
fontawesome_markdown mdx_truly_sane_lists mkdocs-macros-plugin
8+
pip install --no-cache-dir flake8 debugpy pre-commit && \
9+
pip install --no-cache-dir -r docs/requirements.txt

docs/requirements.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
fontawesome_markdown
2+
mdx_truly_sane_lists
3+
mkdocs
4+
mkdocs-awesome-pages-plugin
5+
mkdocs-macros-plugin
6+
mkdocs-material

0 commit comments

Comments
 (0)