search

Ericsson / codechecker

CodeChecker is an analyzer tooling, defect database and viewer extension for static and dynamic analyzer tools.
https://codechecker.readthedocs.io
Apache License 2.0
2.27k stars 381 forks source link

Broken links #3486

Open gastonstrizzolo opened 3 years ago

gastonstrizzolo commented 3 years ago

Hi! this is my first time reporting a bug :). I will do my best Describe the bug In the main page (https://codechecker.readthedocs.io/en/latest/) the following links are broken: https://codechecker.readthedocs.io/web/server/vue-cli/src/assets/userguide/userguide.md All the "Common tools" section in the main page: https://codechecker.readthedocs.io/analyzer/tools/build-logger/README.md https://codechecker.readthedocs.io/docs/tools/plist_to_html.md https://codechecker.readthedocs.io/docs/tools/report-converter.md https://codechecker.readthedocs.io/docs/tools/tu_collector.md https://codechecker.readthedocs.io/docs/tools/codechecker_report_hash.md In the Analyzer page: https://codechecker.readthedocs.io/analyzer/tools/build-logger/README.md

CodeChecker version 6.17

Expected behaviour The link redirects to an existent page

dkrupp commented 3 years ago

Thanks for reporting this.

As far as I see, only the readthedocs.io autogenerated document contains the broken links. The original, github md pages are fine https://github.com/Ericsson/codechecker/tree/master/docs#common-tools

We will need to check why...

whisperity commented 2 years ago

I think the issue is that the mentioned "Common Tools" section has absolute links:

[foo](/tools/foo/README.md)

The MkDocs help says (https://mkdocs.readthedocs.io/en/0.9/user-guide/writing-your-docs/#internal-hyperlinks):

If the target documentation file is in another directory you'll need to make sure to include any relative directory path in the hyperlink.

Please see the [project license](../about/license.md) for further details.

The links on GitHub work fine, because GitHub just links you to the MD file, but can produce the MD file, whereas MkDocs creates HTMLs, and would need to rewrite the links.