[analyzer] Creating standard Sphinx documentation
authorKristof Umann <dkszelethus@gmail.com>
Tue, 5 Feb 2019 00:39:33 +0000 (00:39 +0000)
committerKristof Umann <dkszelethus@gmail.com>
Tue, 5 Feb 2019 00:39:33 +0000 (00:39 +0000)
commit1a17032b788016299ea4e3c4b53670c6dcd94b4f
tree318aac876ac4171cb6613f534126f39430fc193e
parent7f09fd6b045da9fd62529fede180ac3e48a88305
[analyzer] Creating standard Sphinx documentation

The lack of documentation has been a long standing issue in the Static Analyzer,
and one of the leading reasons behind this was a lack of good documentation
infrastucture.

This lead serious drawbacks, such as
* Not having proper release notes for years
* Not being able to have a sensible auto-generated checker documentations (which
lead to most of them not having any)
* The HTML website that has to updated manually is a chore, and has been
outdated for a long while
* Many design discussions are now hidden in phabricator revisions

This patch implements a new documentation infrastucture using Sphinx, like most
of the other subprojects in LLVM. It transformed some pages as a proof-of-
concept, with many others to follow in later patches. The eventual goal is to
preserve the original website's (https://clang-analyzer.llvm.org/) frontpage,
but move everything else to the new format.

Some other ideas, like creating a unipage for each checker (similar to how
clang-tidy works now), are also being discussed.

Patch by Dániel Krupp!

Differential Revision: https://reviews.llvm.org/D54429

llvm-svn: 353126
19 files changed:
clang/docs/ClangStaticAnalyzer.rst [new file with mode: 0644]
clang/docs/analyzer/checkers.rst [new file with mode: 0644]
clang/docs/analyzer/checkers/callandmessage_example.c [new file with mode: 0644]
clang/docs/analyzer/checkers/dealloc_example.m [new file with mode: 0644]
clang/docs/analyzer/checkers/dividezero_example.c [new file with mode: 0644]
clang/docs/analyzer/checkers/mismatched_deallocator_example.cpp [new file with mode: 0644]
clang/docs/analyzer/checkers/newdelete_example.cpp [new file with mode: 0644]
clang/docs/analyzer/checkers/seckeychainapi_example.m [new file with mode: 0644]
clang/docs/analyzer/checkers/unix_api_example.c [new file with mode: 0644]
clang/docs/analyzer/checkers/unix_malloc_example.c [new file with mode: 0644]
clang/docs/analyzer/developer-docs.rst [new file with mode: 0644]
clang/docs/analyzer/developer-docs/DebugChecks.rst [moved from clang/docs/analyzer/DebugChecks.rst with 100% similarity]
clang/docs/analyzer/developer-docs/IPA.rst [moved from clang/docs/analyzer/IPA.txt with 87% similarity]
clang/docs/analyzer/developer-docs/InitializerLists.rst [moved from clang/docs/analyzer/DesignDiscussions/InitializerLists.rst with 71% similarity]
clang/docs/analyzer/developer-docs/RegionStore.rst [moved from clang/docs/analyzer/RegionStore.txt with 72% similarity]
clang/docs/analyzer/developer-docs/nullability.rst [moved from clang/docs/analyzer/nullability.rst with 55% similarity]
clang/docs/analyzer/index.rst [deleted file]
clang/docs/conf.py
clang/docs/index.rst