Standard Clang tools (ThreadSanitizer, MemorySanitizer, DataFlowSanitizer etc.)
all have documentation delivered with Clang and build using Sphinx tool.
Would be great to have the ClangSA docs there too in sphinx markup.
I wonder what you guys think about this approach?
In this patch the analyzer's documentation main and checker pages are
transformed into Sphinx rst to be part of the standard clang documentation tree: https://clang.llvm.org/docs/
The generated new documentation would look like this:
* The documentation is easier to be maintained in Sphinx markup compared to raw HTML
* The documentation is easier found in the standard clang doc tree
* The generated documentation looks nicer ;)
In detail this patch contains the following contributions:
* Transformation of the main page https://clang-analyzer.llvm.org/ to http://cc.elte.hu/clang-docs/docs/html/ClangStaticAnalyzer.html
* Transformation of the https://clang-analyzer.llvm.org/available_checks.html and https://clang-analyzer.llvm.org/alpha_checks.html pages to http://cc.elte.hu/clang-docs/docs/html/analyzer/checkers.html
* Per checker page added for alpha.cplusplus.UninitializedObject checker. Would be great to create similar doc for all checkers in the long term. See http://cc.elte.hu/clang-docs/docs/html/analyzer/checkers/UninitializedObject.html
* Design discussion documents were renamed and formatted to rst and linked from the Development/Design Discussions section.
If you agree with the direction I can transform the rest of the https://clang-analyzer.llvm.org/ documentation into rst. But most importantly we would like to have a per checker one pager doc like the one in http://cc.elte.hu/clang-docs/docs/html/analyzer/checkers/UninitializedObject.html
RST seemed to be a better format than plain HTML. Then we could make mandatory for checker author to write such one pagers to their checkers similar to clang-tidy...