Fix Report-Converter Page on readthedocs

[jay24rajput]

Shifted the Readme files from the tools directory into the docs/tools directory

Fixes #3241

[jay24rajput]

@csordasmarton The tests are failing due to Us shifting the Readme files to the docs folder. Should I modify the tests as tell with the proper path?

Also is there a way to run all these tests(8 tests required for merging) locally on my branch? The make test command runs all the tests in CodeChecker

[csordasmarton]

@jay24rajput in this case the github actions are failed on the make package target. So there is no need to run tests locally for this to reproduce, just run the make package target.

The problem is that in the tools setup.py file we expect that a readme file can be found beside the setup.py file but now we moved it. So I think we should change the setup.py file.

For example: https://github.com/Ericsson/codechecker/blob/master/tools/plist_to_html/setup.py#L5

to this:

import os
import setuptools

readme_file_path = os.path.join(
    "..", "..", "docs", "tools", "plist_to_html.md")

with open(readme_file_path, "r", encoding="utf-8", errors="ignore") as fh:
    long_description = fh.read()

I hope that it will work.

Also there is no need to move each tool readme to a separate directory under the docs folder. So instead of using this: docs/tools/plist_to_html/README.md we can use this docs/tools/plist_to_html.md

[jay24rajput]

Yes that makes sense, renaming the files with their tool name 👍🏻

I ll change the setup files of each tool accordingly and rename the Readme files

[jay24rajput]

@csordasmarton Any idea as to why that one test case is failing cause it passed for the previous commit?

Maybe those changes are required in the package.json and package-lock.json

[csordasmarton]

LGTM!

@jay24rajput The github action failure was a virtual machine / network problem and not related to your changes. I restarted the action and now it is passed.