From 1f071322a7b15acc423e6a2de408f3b3653bde44 Mon Sep 17 00:00:00 2001 From: Kegan Maher Date: Tue, 22 Jun 2021 14:51:44 -0700 Subject: [PATCH 1/2] fix(ci/docs): point action at docs requirements 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: https://github.com/mhausenblas/mkdocs-deploy-gh-pages/issues/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 * https://github.com/psf/black/issues/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: https://github.com/mhausenblas/mkdocs-deploy-gh-pages/issues/105 --- .github/workflows/mkdocs.yml | 2 +- docs/requirements.txt | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) create mode 100644 docs/requirements.txt diff --git a/.github/workflows/mkdocs.yml b/.github/workflows/mkdocs.yml index f3e18eb..1e986e1 100644 --- a/.github/workflows/mkdocs.yml +++ b/.github/workflows/mkdocs.yml @@ -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 }} diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..9a8a4ca --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,2 @@ +mkdocs +mkdocs-material From 399f02e99230d2f838427dc68f5db0ba446bb558 Mon Sep 17 00:00:00 2001 From: Kegan Maher Date: Tue, 22 Jun 2021 15:41:06 -0700 Subject: [PATCH 2/2] fix: add missing requirement --- docs/requirements.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/requirements.txt b/docs/requirements.txt index 9a8a4ca..5ea0fb4 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,2 +1,3 @@ mkdocs mkdocs-material +mkdocstrings