dawidchyrzynski / arduino-home-assistant

ArduinoHA allows to integrate an Arduino/ESP based device with Home Assistant using MQTT.
https://dawidchyrzynski.github.io/arduino-home-assistant/
GNU Affero General Public License v3.0
463 stars 112 forks source link

Generating docs based on sources #231

Open martaisty opened 5 months ago

martaisty commented 5 months ago

Issue

docsrc/Pipfile seems to be broken or something.. :thinking:

I've tried generating docs from sources. Here are versions of the tools:

I kept getting an error

RuntimeError: Failed to lock Pipfile.lock!

Solution (workaround)

I tried different options to fix it and the only option, that helped me, was to ignore Pipfile and install env based on Pipfile.lock :drum: pipenv install --ignore-pipfile

But that's rather a hack, not a fix.

Reason

Try running pipenv install -v:

...
CRITICAL:pipenv.patched.pip._internal.resolution.resolvelib.factory:Cannot install -r /tmp/pipenv-wu0shyio-requirements/pipenv-7n1ejgtg-constraints.txt (line 
2), -r /tmp/pipenv-wu0shyio-requirements/pipenv-7n1ejgtg-constraints.txt (line 4), -r /tmp/pipenv-wu0shyio-requirements/pipenv-7n1ejgtg-constraints.txt (line 
6), -r /tmp/pipenv-wu0shyio-requirements/pipenv-7n1ejgtg-constraints.txt (line 7) and sphinx==5.0.2 because these package versions have conflicting 
dependencies.
INFO:pipenv.patched.pip._internal.resolution.resolvelib.factory:
The conflict is caused by:
    The user requested sphinx==5.0.2
    sphinxcontrib-email 0.3.5 depends on Sphinx>=1.8
    sphinx-press-theme 0.8.0 depends on sphinx>=4.0.1
    breathe 4.34.0 depends on Sphinx!=5.0.0, <6 and >=4.0
    exhale 0.3.4 depends on Sphinx<5 and >=3.0
To fix this you could try to:
1. loosen the range of package versions you've specified
2. remove package versions to allow pip attempt to solve the dependency conflict
...

:exclamation: Pay attention to exhale 0.3.4 depends on Sphinx<5 which conflicts with Pipfile's sphinx = "5.0.2"

Do you think this issue makes sense? Or is it just me having set up something incorrectly?