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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix documentation build by pinning sphinx #325

Merged
merged 1 commit into from
Aug 21, 2023

Conversation

Luthaf
Copy link
Contributor

@Luthaf Luthaf commented Aug 21, 2023

Sphinx recently updated all path from string to pathlib, but some plugins we use are not yet updated.

We are hitting breathe-doc/breathe#943 and pradyunsg/furo#693 for other versions of sphinx.


馃摎 Documentation preview 馃摎: https://equistore--325.org.readthedocs.build/en/325/

Sphinx recently updated all path from string to pathlib,
but some plugins we use are not yet updated.
@@ -1,4 +1,4 @@
sphinx >=4.4
sphinx ==7.1.2
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

to be consistent with rascaline

Suggested change
sphinx ==7.1.2
sphinx < 7.2 # breathe is not compatible with sphinx 7.2 yet

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tried this first, but it gives me error with furo (it seems to resolve to sphinx 6.2 which also fails)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not sure why rascaline is not failing ...

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

okay very nice! lets go for it.

@@ -1,4 +1,4 @@
sphinx >=4.4
sphinx ==7.1.2
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

okay very nice! lets go for it.

@PicoCentauri PicoCentauri merged commit d5c72f9 into lab-cosmo:master Aug 21, 2023
23 checks passed
@Luthaf Luthaf deleted the docs-build branch August 30, 2023 16:55
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

Successfully merging this pull request may close these issues.

None yet

2 participants