softwarepub / hermes

Implementation of the HERMES workflow
https://docs.software-metadata.pub
Other
21 stars 6 forks source link

Building docs fails because of missing dependency #33

Closed ageorgou closed 2 years ago

ageorgou commented 2 years ago

Following the instructions:

poetry run sphinx-apidoc -o docs/source/api src
poetry run sphinx-build -M html docs/source docs/build

the second command fails with

Running Sphinx v4.5.0
loading translations [en]... done

Extension error:
Could not import extension sphinx-favicon (exception: No module named 'sphinx-favicon')
ageorgou commented 2 years ago

This is because the sphinx dependencies, listed in docs/requirements.txt are not included in pyproject.toml or poetry.lock, so are not installed. Two ways around this are:

poikilotherm commented 2 years ago

Sorry we missed updating the README bits about building the docs! Will update!