Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Fix relative links in notebooks and documentation #346

Merged
merged 2 commits into from
Feb 28, 2025

Conversation

adrianjav
Copy link
Contributor

@adrianjav adrianjav commented Feb 14, 2025

Changes:

  1. Fix all relative links in the notebooks to point to the documentation itself (and not the notebooks in the repo).
  2. Remove the absolute links in index.md to relative links instead (mkdocs should address them properly).
  3. The region graph notebook now has a table-of-content (indentation was wrong).
  4. Add site_url to the configuration file of mkdocs.

I have tested them locally using mkdocs serve and everything works well in my machine.

Note: This will break the links on the notebooks themselves when seen from the repository/jupyter directly. (There are solutions to address this, but they are more involved.)

@loreloc loreloc self-requested a review February 28, 2025 15:40
Copy link
Member

@loreloc loreloc left a comment

Choose a reason for hiding this comment

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

Thanks a lot!

@loreloc loreloc merged commit 47b5d51 into april-tools:main Feb 28, 2025
1 of 2 checks passed
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants