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

mkdocs-gallery breaks mkdocstrings links in non-gallery pages #73

Closed
tlambert03 opened this issue Sep 7, 2023 · 3 comments
Closed

mkdocs-gallery breaks mkdocstrings links in non-gallery pages #73

tlambert03 opened this issue Sep 7, 2023 · 3 comments

Comments

@tlambert03
Copy link

It appears that any mkdocstrings link that uses backticks for formatting like [`magicgui.some.class`][] breaks when mkdocs gallery is enabled, even if it's a file that has nothing to do with an example. Here are some screenshots:

with mkdocs-gallery enabled:

Screen Shot 2023-09-07 at 6 42 58 AM

without mkdocs-gallery enabled:

Screen Shot 2023-09-07 at 6 43 32 AM

do you have any thoughts as to why mkdocs gallery might be affecting the behavior of other plugins even in non-gallery pages?

@tlambert03
Copy link
Author

I was able to determine that this is caused by the addition of the pymdownx.inlinehilite extension to config['markdown_extensions'] here. I can reproduce it merely by adding that directly to my config (and excluding mkdocs-gallery altogether). So, it's obviously not an issue here. sorry for the noise!

@tlambert03
Copy link
Author

cross-ref: mkdocstrings/autorefs#34

@smarie
Copy link
Owner

smarie commented Nov 20, 2023

THanks @tlambert03 for reporting and cross-referencing ! Definitely useful for our knowledge base.

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

No branches or pull requests

2 participants