[cfe-dev] [analyzer] migrate Clang Static Analyzer documentation to sphinx

[Dániel Krupp via cfe-dev]

Dear Analyzer Community,


Most standard Clang tools (ThreadSanitizer, MemorySanitizer, DataFlowSanitizer etc.)
have documentation delivered with Clang and build using Sphinx tool at  https://clang.llvm.org/docs/.
I thought it would be great to have the ClangSA docs there too in sphinx markup.

I created a patch https://reviews.llvm.org/D54429 where analyzer's documentation main page and the checker sub-pages are
transformed into Sphinx RST.

This is how it looks like now:

http://cc.elte.hu/clang-docs/docs/html/ClangStaticAnalyzer.html

Advantages:
·         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 ;)

What was also missing (for many users) is the documentation of the checkers. Similar to the one-pagers what we have for clang-tidy: http://clang.llvm.org/extra/clang-tidy/checks/list.html

So a similar listing page is created: http://cc.elte.hu/clang-docs/docs/html/analyzer/checkers.html
With a specific one-pager example: http://cc.elte.hu/clang-docs/docs/html/analyzer/checkers/UninitializedObject.html

In practice the pages can be migrated one by one (after sanitizing them) and at end a redirection can be set up at https://clang-analyzer.llvm.org/.

I wonder what you guys think about this approach?

Thanks,
Daniel
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.llvm.org/pipermail/cfe-dev/attachments/20181113/f24b4ec8/attachment.html>