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

Allow cross-referencing in nav #94

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

haneul
Copy link
Contributor

@haneul haneul commented Feb 21, 2023

Sometimes we want to add a page under different subsites (or main site) in a subsite's nav. While linking with ../ may work, but mkdocs can't properly process as it can't find the page.

It shows error like
WARNING - A relative path to 'test/../cross.md' is included in the 'nav' configuration, which is not found in the documentation files

And the navigation title will be None.

This PR fixes it by having normpath for nav link.

@haneul haneul requested a review from a team as a code owner February 21, 2023 21:16
Copy link
Contributor

@agentbellnorm agentbellnorm left a comment

Choose a reason for hiding this comment

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

Looks good to me, thanks!

Copy link
Contributor

@agentbellnorm agentbellnorm left a comment

Choose a reason for hiding this comment

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

Hi again, I was a bit quick - can you update the changelog and the version in setup.py?

Not sure why the checks are not running. Let's see what happens when you push new changes.

@haneul
Copy link
Contributor Author

haneul commented Feb 24, 2023

okay updated

@agentbellnorm
Copy link
Contributor

Seems like a test needs updated.

@bih
Copy link
Collaborator

bih commented Jan 4, 2024

@haneul Can you go ahead and update the test? I can go ahead and merge this once that's resolved :)

@bih bih added enhancement New feature or request awaiting review labels Jan 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
awaiting review enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants