[PATCH] D54429: [analyzer] Creating standard Sphinx documentation

[Daniel Krupp via Phabricator via cfe-commits]

dkrupp updated this revision to Diff 180221.
dkrupp edited the summary of this revision.
dkrupp added a comment.
Herald added a reviewer: serge-sans-paille.

Thanks @NoQ .
So I created a very simple main page with the table of contents only http://cc.elte.hu/clang-docs/docs/html/ClangStaticAnalyzer.html

The main contribution is that I created checkers.rst (see rendered at http://cc.elte.hu/clang-docs/docs/html/analyzer/checkers.html )
page which contains everything from available_checks.html and the alpha_checks.html pages.

If this patch is accepted then I will update the User Manual/Avaliable Chekcs link in the old homepage to point to this new checker page.

I found some old design documentation in clangs/docs repository: IPA.rst, nullability.rst etc. I fixed some formatting syntax in them and linked them in from the main page under developer-docs section.

After this patch is accepted I plan to continue to transform the rest of the documents (SourceLevelAnnotions, Checker Developer Manual etc.)


CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D54429/new/

https://reviews.llvm.org/D54429

Files:
  docs/ClangStaticAnalyzer.rst
  docs/analyzer/DebugChecks.rst
  docs/analyzer/DesignDiscussions/InitializerLists.rst
  docs/analyzer/IPA.txt
  docs/analyzer/RegionStore.txt
  docs/analyzer/checkers.rst
  docs/analyzer/checkers/callandmessage_example.c
  docs/analyzer/checkers/dealloc_example.m
  docs/analyzer/checkers/dividezero_example.c
  docs/analyzer/checkers/mismatched_deallocator_example.cpp
  docs/analyzer/checkers/newdelete_example.cpp
  docs/analyzer/checkers/seckeychainapi_example.m
  docs/analyzer/checkers/unix_api_example.c
  docs/analyzer/checkers/unix_malloc_example.c
  docs/analyzer/developer-docs.rst
  docs/analyzer/developer-docs/DebugChecks.rst
  docs/analyzer/developer-docs/IPA.rst
  docs/analyzer/developer-docs/InitializerLists.rst
  docs/analyzer/developer-docs/RegionStore.rst
  docs/analyzer/developer-docs/nullability.rst
  docs/analyzer/images/analyzer_xcode_html.png
  docs/analyzer/index.rst
  docs/analyzer/nullability.rst
  docs/conf.py
  docs/index.rst

-------------- next part --------------
A non-text attachment was scrubbed...
Name: D54429.180221.patch
Type: text/x-patch
Size: 184750 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/cfe-commits/attachments/20190104/bd8c358d/attachment-0001.bin>