Fix Report-Converter Page on readthedocs (#3302)

* [docs] Moved all the readme in docs - Created a new folder tools under docs - Moved readme files of all the tools into respective folder in docs/tools - Updated the links in the main Readme and User guide - Setup files for all tool to accept the path of the modified readme files - Removed nested folders in tools folder - Renamed Readmes with the folder name
Ericsson · May 17, 2021 · 09c1fec · 09c1fec
1 parent bdcb5c4
commit 09c1fec
Show file tree

Hide file tree

Showing 12 changed files with 60 additions and 40 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -169,36 +169,36 @@ The following tools are supported:
 | **C/C++**      | [Clang Static Analyzer](https://clang-analyzer.llvm.org/)    |
 |                | [Clang Tidy](https://clang.llvm.org/extra/clang-tidy/)  |
 |                | [Clang Sanitizers](supported_code_analyzers.md#clang-sanitizers)    |
-|                | [Cppcheck](/tools/report-converter/README.md#cppcheck)    |
-|                | [Facebook Infer](/tools/report-converter/README.md#facebook-infer)    |
-|                | [Coccinelle](/tools/report-converter/README.md#coccinelle)    |
-|                | [Smatch](/tools/report-converter/README.md#smatch)    |
-|                | [Kernel-Doc](/tools/report-converter/README.md#kernel-doc)    |
-|                | [Sparse](/tools/report-converter/README.md#sparse)    |
-|                | [cpplint](/tools/report-converter/README.md#cpplint)    |
-| **Java**       | [SpotBugs](/tools/report-converter/README.md#spotbugs)    |
-|                | [Facebook Infer](/tools/report-converter/README.md#fbinfer)    |
-| **Python**     | [Pylint](/tools/report-converter/README.md#pylint)    |
-|                | [Pyflakes](/tools/report-converter/README.md#pyflakes)    |
-| **JavaScript** | [ESLint](/tools/report-converter/README.md#eslint)    |
-| **TypeScript** | [TSLint](/tools/report-converter/README.md#tslint)    |
-| **Go**         | [Golint](/tools/report-converter/README.md#golint)    |
-| **Markdown**   | [Markdownlint](/tools/report-converter/README.md#markdownlint)    |
-|                | [Sphinx](/tools/report-converter/Readme.md#sphinx)    |
+|                | [Cppcheck](/docs/tools/report-converter.md#cppcheck)    |
+|                | [Facebook Infer](/docs/tools/report-converter.md#facebook-infer)    |
+|                | [Coccinelle](/docs/tools/report-converter.md#coccinelle)    |
+|                | [Smatch](/docs/tools/report-converter.md#smatch)    |
+|                | [Kernel-Doc](/docs/tools/report-converter.md#kernel-doc)    |
+|                | [Sparse](/docs/tools/report-converter.md#sparse)    |
+|                | [cpplint](/docs/tools/report-converter.md#cpplint)    |
+| **Java**       | [SpotBugs](/docs/tools/report-converter.md#spotbugs)    |
+|                | [Facebook Infer](/docs/tools/report-converter.md#fbinfer)    |
+| **Python**     | [Pylint](/docs/tools/report-converter.md#pylint)    |
+|                | [Pyflakes](/docs/tools/report-converter.md#pyflakes)    |
+| **JavaScript** | [ESLint](/docs/tools/report-converter.md#eslint)    |
+| **TypeScript** | [TSLint](/docs/tools/report-converter.md#tslint)    |
+| **Go**         | [Golint](/docs/tools/report-converter.md#golint)    |
+| **Markdown**   | [Markdownlint](/docs/tools/report-converter.md#markdownlint)    |
+|                | [Sphinx](/docs/tools/report-converter.md#sphinx)    |
 
 
 For details see 
 [supported code analyzers](supported_code_analyzers.md) documentation and the 
-[Report Converter Tool](/tools/report-converter/README.md).
+[Report Converter Tool](/docs/tools/report-converter.md).
 
 ## Common Tools
 Useful tools that can also be used outside CodeChecker.
 
 * [Build Logger (to generate JSON Compilation Database from your builds)](/analyzer/tools/build-logger/README.md)
-* [Plist to HTML converter (to generate HTML files from the given plist files)](/tools/plist_to_html/README.md)
-* [Report Converter Tool (to convert analysis results from other analyzers to the codechecker report directory format))](/tools/report-converter/README.md)
-* [Translation Unit Collector (to collect source files of a translation unit or to get source files which depend on the given header files)](/tools/tu_collector/README.md)
-* [Report Hash generator (to generate unique hash identifiers for reports)](/tools/codechecker_report_hash/README.md)
+* [Plist to HTML converter (to generate HTML files from the given plist files)](/docs/tools/plist_to_html.md)
+* [Report Converter Tool (to convert analysis results from other analyzers to the codechecker report directory format))](/docs/tools/report-converter.md)
+* [Translation Unit Collector (to collect source files of a translation unit or to get source files which depend on the given header files)](/docs/tools/tu_collector.md)
+* [Report Hash generator (to generate unique hash identifiers for reports)](/docs/tools/codechecker_report_hash.md)
 
 ## Helper Scripts
 * [Helper Scripts for daily analysis](script_daily.md)

diff --git a/docs/supported_code_analyzers.md b/docs/supported_code_analyzers.md
@@ -13,25 +13,25 @@ CodeChecker result directory which can be stored to a CodeChecker server.
 | **C/C++**      | [Clang Tidy](https://clang.llvm.org/extra/clang-tidy/)  | ✓ |
 |                | [Clang Static Analyzer](https://clang-analyzer.llvm.org/)    | ✓ |
 |                | [Clang Sanitizers](#clang-sanitizers)    | ✓ |
-|                | [Cppcheck](/tools/report-converter/README.md#cppcheck)    | ✓ |
-|                | [Facebook Infer](/tools/report-converter/README.md#fbinfer)    | ✓ |
-|                | [Coccinelle](/tools/report-converter/README.md#coccinelle)   | ✓ |
-|                | [Smatch](/tools/report-converter/README.md#smatch)   | ✓ |
-|                | [Kernel-Doc](/tools/report-converter/README.md#kernel-doc)   | ✓ |
-|                | [Sparse](/tools/report-converter/README.md#sparse)   | ✓ |
-|                | [cpplint](/tools/report-converter/README.md#cpplint)   | ✓ |
+|                | [Cppcheck](/docs/tools/report-converter.md#cppcheck)    | ✓ |
+|                | [Facebook Infer](/docs/tools/report-converter.md#fbinfer)    | ✓ |
+|                | [Coccinelle](/docs/tools/report-converter.md#coccinelle)   | ✓ |
+|                | [Smatch](/docs/tools/report-converter.md#smatch)   | ✓ |
+|                | [Kernel-Doc](/docs/tools/report-converter.md#kernel-doc)   | ✓ |
+|                | [Sparse](/docs/tools/report-converter.md#sparse)   | ✓ |
+|                | [cpplint](/docs/tools/report-converter.md#cpplint)   | ✓ |
 | **Java**       | [FindBugs](http://findbugs.sourceforge.net/)    | ✗ |
-|                | [SpotBugs](/tools/report-converter/README.md#spotbugs)    | ✓ |
-|                | [Facebook Infer](/tools/report-converter/README.md#fbinfer)    | ✓ |
-| **Python**     | [Pylint](/tools/report-converter/README.md#pylint)    | ✓ |
-|                | [Pyflakes](/tools/report-converter/README.md#pyflakes)    | ✓ |
+|                | [SpotBugs](/docs/tools/report-converter.md#spotbugs)    | ✓ |
+|                | [Facebook Infer](/docs/tools/report-converter.md#fbinfer)    | ✓ |
+| **Python**     | [Pylint](/docs/tools/report-converter.md#pylint)    | ✓ |
+|                | [Pyflakes](/docs/tools/report-converter.md#pyflakes)    | ✓ |
 |                | [mypy](http://mypy-lang.org/)    | ✗ |
 |                | [Bandit](https://github.com/PyCQA/bandit)    | ✗ |
 | **JavaScript** | [ESLint](https://eslint.org/)    | ✓ |
 |                | [JSHint](https://jshint.com/)    | ✗ |
 |                | [JSLint](https://jslint.com/)    | ✗ |
-| **TypeScript** | [TSLint](/tools/report-converter/README.md#tslint)    | ✓ |
-| **Go**         | [Golint](/tools/report-converter/README.md#golint)    | ✓ |
+| **TypeScript** | [TSLint](/docs/tools/report-converter.md#tslint)    | ✓ |
+| **Go**         | [Golint](/docs/tools/report-converter.md#golint)    | ✓ |
 |                | [Staticcheck](https://staticcheck.io/)    | ✗ |
 |                | [go-critic](https://github.com/go-critic/go-critic)    | ✗ |
 | **Markdown**   | [Markdownlint](https://github.com/markdownlint/markdownlint)    | ✓ |
@@ -50,4 +50,4 @@ CodeChecker result directory which can be stored to a CodeChecker server.
 We support to convert multiple sanitizer output to a CodeChecker report
 directory which can be stored to a CodeChecker server by using our
 [report-converter](/tools/report-converter) tool. For more information how to
-use this tool see the [user guide](/tools/report-converter/README.md).
+use this tool see the [user guide](/docs/tools/report-converter.md).
diff --git a/tools/bazel/README.md → docs/tools/bazel.md b/tools/bazel/README.md → docs/tools/bazel.md
diff --git a/tools/codechecker_report_hash/README.md → docs/tools/codechecker_report_hash.md b/tools/codechecker_report_hash/README.md → docs/tools/codechecker_report_hash.md
diff --git a/tools/plist_to_html/README.md → docs/tools/plist_to_html.md b/tools/plist_to_html/README.md → docs/tools/plist_to_html.md
diff --git a/tools/report-converter/README.md → docs/tools/report-converter.md b/tools/report-converter/README.md → docs/tools/report-converter.md
diff --git a/tools/tu_collector/README.md → docs/tools/tu_collector.md b/tools/tu_collector/README.md → docs/tools/tu_collector.md
diff --git a/tools/bazel/setup.py b/tools/bazel/setup.py
@@ -1,8 +1,12 @@
 #!/usr/bin/env python3
 
+import os
 import setuptools
 
-with open("README.md", "r", encoding="utf-8", errors="ignore") as fh:
+readme_file_path = os.path.join(
+    "..", "..", "docs", "tools", "bazel.md")
+
+with open(readme_file_path, "r", encoding="utf-8", errors="ignore") as fh:
     long_description = fh.read()
 
 setuptools.setup(

diff --git a/tools/codechecker_report_hash/setup.py b/tools/codechecker_report_hash/setup.py
@@ -1,9 +1,13 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 
+import os
 import setuptools
 
-with open("README.md", "r") as fh:
+readme_file_path = os.path.join(
+    "..", "..", "docs", "tools", "codechecker_report_hash.md")
+
+with open(readme_file_path, "r") as fh:
     long_description = fh.read()
 
 setuptools.setup(

diff --git a/tools/plist_to_html/setup.py b/tools/plist_to_html/setup.py
@@ -1,8 +1,12 @@
 #!/usr/bin/env python3
 
+import os
 import setuptools
 
-with open("README.md", "r", encoding="utf-8", errors="ignore") as fh:
+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()
 
 setuptools.setup(

diff --git a/tools/report-converter/setup.py b/tools/report-converter/setup.py
@@ -1,9 +1,13 @@
 #!/usr/bin/env python3
 
+import os
 import setuptools
 import codechecker_report_converter
 
-with open("README.md", "r", encoding="utf-8", errors="ignore") as fh:
+readme_file_path = os.path.join(
+    "..", "..", "docs", "tools", "report-converter.md")
+
+with open(readme_file_path, "r", encoding="utf-8", errors="ignore") as fh:
     long_description = fh.read()
 
 setuptools.setup(

diff --git a/tools/tu_collector/setup.py b/tools/tu_collector/setup.py
@@ -1,8 +1,12 @@
 #!/usr/bin/env python3
 
+import os
 import setuptools
 
-with open("README.md", "r", encoding="utf-8", errors="ignore") as fh:
+readme_file_path = os.path.join(
+    "..", "..", "docs", "tools", "tu_collector.md")
+
+with open(readme_file_path, "r", encoding="utf-8", errors="ignore") as fh:
     long_description = fh.read()
 
 setuptools.setup(