Skip to content

Commit

Permalink
fix(ci/docs): point action at docs requirements
Browse files Browse the repository at this point in the history
mhausenblas/mkdocs-deploy-gh-pages needs a requirements file, else it
tries to install the repo-level requirements, which typically are not
needed for the docs site, see:
mhausenblas/mkdocs-deploy-gh-pages#53

introduce requirements file specific to the docs site, fixing an issue
with trying to install the dev-requirements.txt

the underlying issue was with trying to install black into the Docker
image used by this GitHub Action (squidfunk/mkdocs-material:7.1.8), see:
https://github.com/mhausenblas/mkdocs-deploy-gh-pages/blob/master/Dockerfile

recent versions of black depend on regex, which has a history of trouble
with Linux wheel availability and support

* psf/black#1207
* https://bitbucket.org/mrabarnett/mrab-regex/issues/343/wheel-for-linux
* https://bitbucket.org/mrabarnett/mrab-regex/issues/349/no-module-named-regex_regex-regex-is-not-a

the Docker image does not have gcc available; rather than installing a
build chain to build regex to enable the install of black, which isn't
even used by the docs site, the simpler fix was to create a
docs/requirements.txt and point the GitHub Action at it instead

similar report on the Action repo:
mhausenblas/mkdocs-deploy-gh-pages#105
  • Loading branch information
thekaveman committed Jun 22, 2021
1 parent 10c4157 commit 1f07132
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .github/workflows/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,5 @@ jobs:
- name: Deploy docs
uses: mhausenblas/mkdocs-deploy-gh-pages@master
env:
REQUIREMENTS: dev-requirements.txt
REQUIREMENTS: docs/requirements.txt
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
2 changes: 2 additions & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
mkdocs
mkdocs-material

0 comments on commit 1f07132

Please sign in to comment.