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

Fix relative links in notebooks and documentation #346

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

adrianjav
Copy link

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 exists to address this, but they are more involved.)

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.

1 participant