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

Generating docs based on sources #231

Open
martaisty opened this issue Feb 10, 2024 · 0 comments
Open

Generating docs based on sources #231

martaisty opened this issue Feb 10, 2024 · 0 comments

Comments

@martaisty
Copy link
Contributor

Issue

docsrc/Pipfile seems to be broken or something.. 🤔

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

  • Doxygen 1.9.7
  • Python 3.9.18
  • Pipenv 2023.12.1

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 🥁
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
...

❗ 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?

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

No branches or pull requests

1 participant