[docs]Can't open the 'Report Converter Tool' page

[uhziel]

Describe the bug

Can't open the 'Report Converter Tool' page

Can only use 'https://github.com/Ericsson/codechecker/blob/master/tools/report-converter/README.md' to access.

To Reproduce

1. Open https://codechecker.readthedocs.io/en/latest/
2. Find 'Report Converter Tool'
3. Click on 'Report Converter Tool'

[jay24rajput]

@csordasmarton I would like to work on this issue. Maybe you can direct me as to why the hyperlink is breaking(since it is displaying data directly from github readme links)

[csordasmarton]

@jay24rajput The documentation what you can see when you visit this link is generated by using mkdocs. The configuration file which describe the options how it is built can be found here:

codechecker/mkdocs.yml

Line 7 in cc64e48

docs_dir: 'docs'

Unforunately you can specify only one directory for this tool and it walk through all the files in this directory and generates this documentation. The problem is that our CodeChecker repository contains multiple "sub-modules" / tools, and the documentation can be found in different locations.

So a solution can be if we move every documentation files under the docs directory.

For example:

|- docs
  |- analyzer
  |- web
  |- tools
    |- report_converter.md
    |- plist_to_html.md
    |- ...

[jay24rajput]

@csordasmarton Hmm.. but that would make its documentation messed up I think. Do you think we shift all the readme files to the folder?

I was also thinking, maybe we can issue a make command for copying all the readme files in the project to the docs directory. Something like this:

make docs

It would also overwrite all the files in there exists one already

[csordasmarton]

@jay24rajput The documentation is generated automatically by the https://readthedocs.org/ page which reads the above mention configuration file from the repository. I don't think it supports custom build processes (like make) and I don't see any option for it on the Administrator page.

[jay24rajput]

@csordasmarton Ohh alright! This leaves us with no option but to shift the readme files to the docs folder right?

[csordasmarton]

@jay24rajput Unfortunately yes, I don't see any other solution for this problem now.

[jay24rajput]

Hello @csordasmarton

In spite of the PR is merged, the readthedocs still shows 404 error (https://codechecker.readthedocs.io/docs/tools/report-converter.md#kernel-doc)