-
Notifications
You must be signed in to change notification settings - Fork 3.1k
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
Links from c Modules to Lua Modules in documentation don't work #3495
Comments
Actually I thought about the $("div.section a[href^='" + relativePath + "']") snippet. What about if we only adapt links to ../../dev. |
I'll take a look later this week I hope.
Well, the tweak cannot be branch-dependent. I was thinking about checking whether the link points to any of the dirs in the /docs folder. Those are the ones that the tweak must not be applied to as anything inside this dir is (correctly) managed by MkDocs. |
Do not change the URL to artifacts that reside inside the `/docs` folder as they are correctly managed by MkDocs. Fixes #3495
Well done. Works as expected |
Thanks for testing Gregor |
Do not change the URL to artifacts that reside inside the `/docs` folder as they are correctly managed by MkDocs. Fixes #3495
See the link on https://nodemcu.readthedocs.io/en/dev/modules/node/#example_7
Expected behavior
point to https://nodemcu.readthedocs.io/en/dev/lua-modules/telnet/
Actual behavior
points to https://github.com/nodemcu/nodemcu-firmware/tree/dev/lua-modules/telnet/ which does not exist
Test code
The link is as follows: ../lua-modules/telnet.md
NOTE:
links like ../../app/modules/node.c work as desired and point to https://github.com/nodemcu/nodemcu-firmware/tree/dev/app/modules/node.c
NodeMCU startup banner
N/A
Hardware
irrelevant
Prior discussion starts here:
#3489 (comment)
The text was updated successfully, but these errors were encountered: