forked from OSchip/llvm-project
87d8ae700b
Summary: This is an attempt to simply the process of building the clang documentation, which should help avoid some of the recent issues we've had generating the documentation for the website. The html documentation for clang is generated by sphinx from the reStructuredText (rst) files we have in the clang/docs directory. There are also some rst files that need to be generated by TableGen, before they can be passed to sphinx. Prior to this patch we were not generating those rst files as part with the build system and they had to be generated manually. This patch enables the automatic generation of these rst files, but since they are generated at build time the cannot be placed in the clang/docs directory and must go into the cmake build directory. Unfortunately sphinx does not currently support multiple source directories[1], so in order to be able to generate the full documentation, we need to work around this by copying the rst files from the clang/docs into the build directory before generating the html documentation. [1] https://github.com/sphinx-doc/sphinx/issues/3132 Reviewers: rsmith, aaron.ballman, beanz, smeenai, phosek, compnerd, mgorny, delcypher Reviewed By: mgorny, delcypher Subscribers: delcypher, merge_guards_bot, mgorny, llvm-commits, cfe-commits Tags: #clang, #llvm Differential Revision: https://reviews.llvm.org/D72875 |
||
|---|---|---|
| .. | ||
| CommandGuide | ||
| analyzer | ||
| tools | ||
| AddressSanitizer.rst | ||
| AutomaticReferenceCounting.rst | ||
| Block-ABI-Apple.rst | ||
| Block-ABI-Apple.txt | ||
| BlockLanguageSpec.rst | ||
| CMakeLists.txt | ||
| ClangCheck.rst | ||
| ClangCommandLineReference.rst | ||
| ClangFormat.rst | ||
| ClangFormatStyleOptions.rst | ||
| ClangPlugins.rst | ||
| ClangStaticAnalyzer.rst | ||
| ClangTools.rst | ||
| ConstantInterpreter.rst | ||
| ControlFlowIntegrity.rst | ||
| ControlFlowIntegrityDesign.rst | ||
| CrossCompilation.rst | ||
| DataFlowSanitizer.rst | ||
| DataFlowSanitizerDesign.rst | ||
| DiagnosticsReference.rst | ||
| DriverArchitecture.png | ||
| DriverInternals.rst | ||
| ExternalClangExamples.rst | ||
| FAQ.rst | ||
| HardwareAssistedAddressSanitizerDesign.rst | ||
| HowToSetupToolingForLLVM.rst | ||
| InternalsManual.rst | ||
| IntroductionToTheClangAST.rst | ||
| ItaniumMangleAbiTags.rst | ||
| JSONCompilationDatabase.rst | ||
| LTOVisibility.rst | ||
| LanguageExtensions.rst | ||
| LeakSanitizer.rst | ||
| LibASTImporter.rst | ||
| LibASTMatchers.rst | ||
| LibASTMatchersReference.html | ||
| LibASTMatchersTutorial.rst | ||
| LibFormat.rst | ||
| LibTooling.rst | ||
| MSVCCompatibility.rst | ||
| Makefile.sphinx | ||
| MemorySanitizer.rst | ||
| Modules.rst | ||
| ObjectiveCLiterals.rst | ||
| OpenCLSupport.rst | ||
| OpenMPSupport.rst | ||
| PCHInternals.rst | ||
| PCHLayout.graffle | ||
| PCHLayout.png | ||
| RAVFrontendAction.rst | ||
| README.txt | ||
| RefactoringEngine.rst | ||
| ReleaseNotes.rst | ||
| SafeStack.rst | ||
| SanitizerCoverage.rst | ||
| SanitizerSpecialCaseList.rst | ||
| SanitizerStats.rst | ||
| ShadowCallStack.rst | ||
| SourceBasedCodeCoverage.rst | ||
| ThinLTO.rst | ||
| ThreadSafetyAnalysis.rst | ||
| ThreadSanitizer.rst | ||
| Toolchain.rst | ||
| Tooling.rst | ||
| UndefinedBehaviorSanitizer.rst | ||
| UsersManual.rst | ||
| conf.py | ||
| doxygen-mainpage.dox | ||
| doxygen.cfg.in | ||
| index.rst | ||
| make.bat | ||
README.txt
See llvm/docs/README.txt