Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix docs site build #4

Closed
wants to merge 2 commits into from
Closed

Fix docs site build #4

wants to merge 2 commits into from

Conversation

thekaveman
Copy link
Member

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

This PR introduces a 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

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

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
@thekaveman thekaveman marked this pull request as draft June 22, 2021 22:56
@e-lo e-lo self-assigned this Jun 29, 2021
@e-lo
Copy link
Collaborator

e-lo commented Jun 29, 2021

Man - why does black need a separate regexer - ug.
But yes, this approach seems good to me.

@thekaveman
Copy link
Member Author

An interesting anecdote: dials/dials#1585 (comment)

@thekaveman thekaveman closed this Jan 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants