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

Wrong version recommendation of shpinx when building documentation #6528

Open
emiliostassios opened this issue Aug 10, 2024 · 3 comments
Open

Comments

@emiliostassios
Copy link
Contributor

The page suggests to use:
pip install --user "sphinx<5" sphinx-book-theme breathe sphinxcontrib-bibtex sphinx-copybutton

Actual Behavior

There are version conflicts with sphinx<5 (4.5.0, recommended on the page).

Solution

I succeded in building HPX with these steps:
Install docutils<0.18
and pip install --user "sphinx<6" sphinx-book-theme breathe sphinxcontrib-bibtex sphinx-copybutton

... Please describe your environment

  • HPX Version: HPX v1.10.0
  • Python version: Python 3.10.12
  • Platform (compiler, OS): WSL (Ubuntu)
@hkaiser
Copy link
Member

hkaiser commented Nov 20, 2024

@dimitraka could you fix the docs according to @emiliostassios report, please?

@dimitraka
Copy link
Contributor

Eventually which sphinx version worked? We need the exact version to list it in the prerequisites.

@emiliostassios
Copy link
Contributor Author

emiliostassios commented Dec 8, 2024 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants