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

Cannot open documentation #175

Closed
LauKo20 opened this issue Aug 7, 2023 · 3 comments
Closed

Cannot open documentation #175

LauKo20 opened this issue Aug 7, 2023 · 3 comments
Assignees

Comments

@LauKo20
Copy link

LauKo20 commented Aug 7, 2023

Hi, the link to the documentation is not working. I get the error message "File not found - The site configured at this address does not contain the requested file. "

Thanks in advance

@locastre
Copy link
Contributor

Documentation still unavailable at https://pyxnat.github.io/pyxnat/

@jhuguetn
Copy link
Contributor

Thanks both, @LauKo20 and @locastre for bringing that out.

I believe the cause is in the building step of the documentation pages, which is failing due to the version of Sphinx package installed by the docs CI workflow. Sphinx 7.x has deprecated the style key which is still used by our docs theme (standford theme). See similar raised issues here and here.

I will for now pin Sphinx<7.0 to bring documentation back to life and we'll explore in a future if we can migrate to another theme which does support newer versions of Sphinx and thus remove the Sphinx version restriction workaround.

@jhuguetn
Copy link
Contributor

Docs are back to life now. Closing this issue, thank you.

Btw, I see now that our Sphinx theme repo (https://github.com/DrJimFan/Sphinx-theme) has been archived just few months ago and is no longer maintained/active. More arguments for migrating to another theme package (the RTDs theme, for instance).

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

3 participants