granicus.if.org Git - clang/blob - docs/index.rst

   1 .. Clang documentation master file, created by
   2    sphinx-quickstart on Sun Dec  9 20:01:55 2012.
   3    You can adapt this file completely to your liking, but it should at least
   4    contain the root `toctree` directive.
   5
   6 .. title:: Welcome to Clang's documentation!
   7
   8 .. toctree::
   9    :maxdepth: 1
  10
  11    ReleaseNotes
  12
  13 Using Clang as a Compiler
  14 =========================
  15
  16 .. toctree::
  17    :maxdepth: 1
  18
  19    UsersManual
  20    LanguageExtensions
  21    AttributeReference
  22    CrossCompilation
  23    ThreadSafetyAnalysis
  24    AddressSanitizer
  25    ThreadSanitizer
  26    MemorySanitizer
  27    UndefinedBehaviorSanitizer
  28    DataFlowSanitizer
  29    LeakSanitizer
  30    SanitizerCoverage
  31    SanitizerSpecialCaseList
  32    ControlFlowIntegrity
  33    SafeStack
  34    Modules
  35    MSVCCompatibility
  36    CommandGuide/index
  37    FAQ
  38
  39 Using Clang as a Library
  40 ========================
  41
  42 .. toctree::
  43    :maxdepth: 1
  44
  45    Tooling
  46    ExternalClangExamples
  47    IntroductionToTheClangAST
  48    LibTooling
  49    LibFormat
  50    ClangPlugins
  51    RAVFrontendAction
  52    LibASTMatchersTutorial
  53    LibASTMatchers
  54    HowToSetupToolingForLLVM
  55    JSONCompilationDatabase
  56
  57 Using Clang Tools
  58 =================
  59
  60 .. toctree::
  61    :maxdepth: 1
  62
  63    ClangTools
  64    ClangCheck
  65    ClangFormat
  66    ClangFormatStyleOptions
  67
  68 Design Documents
  69 ================
  70
  71 .. toctree::
  72    :maxdepth: 1
  73
  74    InternalsManual
  75    DriverInternals
  76    PTHInternals
  77    PCHInternals
  78
  79
  80 Indices and tables
  81 ==================
  82
  83 * :ref:`genindex`
  84 * :ref:`modindex`
  85 * :ref:`search`
  86