Hyperlinks to source code within documentation contain absolute path on obiot's PC
Describe the bug Hyperlinks to source code lines on github within the Documentation on https://melonjs.github.io/melonJS/docs/index.html , are broken. They include @obiot 's absolute path to his source workspace, rather than relative path.
To Reproduce
- Go to collision overview documentation
- Click on maxChildren source link collision.js:11
- See error --> 404: 'The master branch of melonJS does not contain the path Users/obiot/Documents/GitHub/melonJS/src/physics/collision.js.'
Expected behavior link to https://github.com/melonjs/melonJS/blob/master/src/physics/collision.js#L11 instead
Device (please complete the following information):
- Browser: Firefox 122.0 (but it shouldn't matter, the hyperlinks are broken)
- melonJS Version: latest (documentation site)
Good catch ! unfortunately this seems to be a problem with webdoc that we use to generate our documentation, and webdoc is not maintained anymore. So while it looks like an easy fix, Im afraid the only way is to move to something else for doc generation
Would you like a workaround? I've built a quick and dirty Dockerfile that just clones this repo into "/", does npm install; npm run doc-prod. That generates this:
<a href=https://github.com/melonjs/melonJS/blob/master//src/physics/collision.js#L33>collision.js:33</a>
collision.js:33
Sent you a PR #1217 Thanks for all of your hard work! Enjoying using the engine and the docs are great too!
closing as this was solved with the corresponding Pull Request. thanks again for this !