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

Attempt to fix issue with doc building on Mac/Windows #436

Merged
merged 5 commits into from
Jan 19, 2024

Conversation

adehecq
Copy link
Member

@adehecq adehecq commented Jan 17, 2024

Attempts to fix an issue only referenced on xdem: GlacioHack/xdem#316.

Raised issue #442 for the Windows problem.

@adehecq adehecq changed the title Attempt to fix doc building issue on Mac Fix issue with doc building on Mac/Windows Jan 17, 2024
@adehecq
Copy link
Member Author

adehecq commented Jan 17, 2024

Should I disable tests for Windows then? Or we should have someone test it locally on a Windows to understand the issue...

@adehecq adehecq requested a review from rhugonnet January 17, 2024 13:25
@adehecq adehecq changed the title Fix issue with doc building on Mac/Windows Attempt to fix issue with doc building on Mac/Windows Jan 17, 2024
@rhugonnet
Copy link
Member

Talk about a useless message, Undefined error... 😓

It also says "Theme error" right next to it.
We could try unfixing the pydata-sphinx-theme version that had to be fixed to build correctly with sphinx-book-theme: https://github.com/GlacioHack/geoutils/blob/main/dev-environment.yml#L32. See issue: #413.

We can unfix it now because Sphinx book theme just released a new version that works with the new Pydata theme: https://github.com/executablebooks/sphinx-book-theme/releases, and apparently fixes a lot of bugs.

If the rendering is good, it would also solve issue GlacioHack/xdem#452 once mirrored in xDEM! 🙂

@rhugonnet
Copy link
Member

And otherwise yes, we should probably not lose time on this mysterious error and just skip Windows

@adehecq
Copy link
Member Author

adehecq commented Jan 18, 2024

@rhugonnet, the test does not fail on Windows anymore after unfixing the sphinx-book-theme !! 🥳
You can check the new doc here: https://geoutils-adehecq.readthedocs.io
I didn't see any issue. The theme is slightly different than the previous one, but it looks fine.

Copy link
Member

@rhugonnet rhugonnet left a comment

Choose a reason for hiding this comment

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

Amazing!! We're solving a lot of old problems :)

@adehecq
Copy link
Member Author

adehecq commented Jan 19, 2024

Pfff, after merging with the main branch, the doc build fails again on Windows. It seems related to the new CLI section. The path to the script geoviewer.py is not found on windows. This may be a sign that actually, geoviewer.py is not working on Windows?

@adehecq adehecq merged commit f57df0d into GlacioHack:main Jan 19, 2024
10 checks passed
@adehecq adehecq deleted the fix_doc branch January 19, 2024 14:22
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.

2 participants