Skip to content

Conversation

@nightcoder26
Copy link

This PR addresses the issue where links were not rendering correctly in tutorials.html, related to the path configuration in Sphinx. After moving the notebooks folder inside the docs directory, the links are now correctly rendered.

Changes:

  • Moved the notebooks folder inside the docs directory to resolve path issues.
  • Added the generated folder to .gitignore to prevent tracking of generated files.

Screenshots:

Before: The links were not rendered correctly due to path issues.
434477815-0abf2c0b-ac69-47e7-987c-9211cdd55676

image

After: The links are now rendered correctly after moving the notebooks.
image

Please review and let me know if any further changes are needed.

@gegen07 gegen07 added the docs label Apr 17, 2025
@gegen07 gegen07 self-requested a review April 17, 2025 11:17
@gegen07 gegen07 assigned gegen07 and nightcoder26 and unassigned gegen07 Apr 17, 2025
@gegen07
Copy link
Member

gegen07 commented Apr 19, 2025

Hi @nightcoder26!

Please provide the steps you ran through to replicate the error. Could you also provide your environment config?
I did a fresh install on main branch and did not find the errors mentioned.

Thanks!

@martinfleis
Copy link
Member

I don't think we can do it like this as the notebooks folder is pulled by the PySAL notebooks project.

@nightcoder26
Copy link
Author

Hi @nightcoder26!

Please provide the steps you ran through to replicate the error. Could you also provide your environment config? I did a fresh install on main branch and did not find the errors mentioned.

Thanks!

Hi,
I'm working on a Windows setup and did not use the make html command to build the documentation as there was no make.bat . Instead, I used:

sphinx-build -b html . _build

Since the make command didn’t work on Windows, I built the docs using sphinx-build directly. To get the links rendering correctly, I manually moved the notebooks/ folder into docs/.

@martinfleis
Copy link
Member

Given our docs is built on Ubuntu, I don't see this as an issue.

@gegen07
Copy link
Member

gegen07 commented Apr 19, 2025

@nightcoder26 as Martin commented, our docs is built on Ubuntu and my fresh installation on Ubuntu did not throw any error/warning, so I will close this PR.

@gegen07 gegen07 closed this Apr 19, 2025
@nightcoder26 nightcoder26 deleted the fix-sphinx-path branch April 19, 2025 16:33
@nightcoder26
Copy link
Author

nightcoder26 commented Apr 19, 2025

@nightcoder26 as Martin commented, our docs is built on Ubuntu and my fresh installation on Ubuntu did not throw any error/warning, so I will close this PR.

Hey thank you for explaining that!
Just a small thought - would it make sense to include a make.bat file for any contributors working on Windows who might want to build and preview the docs locally? It might help avoid confusion in the future for devs.

Happy to help with that if needed.

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

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants