search

missionpinball / mpf-docs

missionpinball.org website content & all MPF docs
https://missionpinball.org/
MIT License
30 stars 114 forks source link

Include files use absolute links which generate lots of warnings #488

Open toomanybrians opened 1 year ago

toomanybrians commented 1 year ago

Originally posted by @worldpeace-germany in https://github.com/missionpinball/mpf-docs/issues/482#issuecomment-1689916491

I cloned the repro and running the server with the docs locally throws hundreds of message because of absolute links. From my point of view all these messages might make it hard to see real issues. Most of these links are inside the includes. Is there something we can do about it? Just changing them to relative links might break it. Do we need the includes, makes it live really that much easier?

toomanybrians commented 1 year ago

I think the includes are used a lot. I guess we don’t absolutely need them, but then there would be lots of repeated text so anyone who updated that text would need to find and replace across many files.

I wonder if it’s possible to specific some kind of config option in mkdocs to suppress those types of warnings? I’ll keep this issue open to investigate

worldpeace-germany commented 1 week ago

Cross reference https://github.com/missionpinball/mpf-docs/issues/538