Uberspace / lab

The Uberlab provides various tutorials - written by you! - on how to run software and tools on Uberspace 7.
https://lab.uberspace.de
Other
308 stars 406 forks source link

Cannot execute `make clean html` after running `make setup` #1739

Closed MetroMarv closed 2 months ago

MetroMarv commented 3 months ago

Steps to reproduce

Sphinx version error: The sphinxcontrib.applehelp extension used by this project needs at least Sphinx v5.0; it therefore cannot be built with this version. make: *** [html] Error 2

- install matching dependencies for sphinxcontib libs `pip install --force-reinstall 'sphinxcontrib-applehelp==1.0.2' 'sphinxcontrib-devhelp==1.0.2' 'sphinxcontrib-htmlhelp==2.0.0' 'sphinxcontrib-serializinghtml==1.1.5' 'sphinxcontrib-qthelp==1.0.3'`
- try again `make clean html`

Removing everything under 'build'... Running Sphinx v4.4.0

Extension error: Could not import extension sphinxcontrib.spelling (exception: The 'enchant' C library was not found and maybe needs to be installed. See https://pyenchant.github.io/pyenchant/install.html for details ) make: *** [html] Error 2


- install enchant `brew install enchant`
- then it works

Environment

macOS Sonoma - 14.2.1
Python 3.11
MetroMarv commented 3 months ago

I actually would expect that pip does know which versions are compatible. Maybe it's something with my system?

Anyways I created a PR that solved the problem for me.

The workaround is to install dependencies manually and also install Enchant. So after you executed make setup and source .venv/bin/activate execute this steps:

pip install --force-reinstall 'sphinxcontrib-applehelp==1.0.2' 'sphinxcontrib-devhelp==1.0.2' 'sphinxcontrib-htmlhelp==2.0.0' 'sphinxcontrib-serializinghtml==1.1.5' 'sphinxcontrib-qthelp==1.0.3'

# install Enchant - following line only works for MacOS with Homebrew
brew install enchant

How to install Enchant for other OS see here: http://pyenchant.github.io/pyenchant/install.html#installing-the-enchant-c-library