[clang-tools-extra] r354779 - Updated the documentation build instructions for the current CMake build system
Dmitri Gribenko via cfe-commits
cfe-commits at lists.llvm.org
Mon Feb 25 05:03:44 PST 2019
Author: gribozavr
Date: Mon Feb 25 05:03:44 2019
New Revision: 354779
URL: http://llvm.org/viewvc/llvm-project?rev=354779&view=rev
Log:
Updated the documentation build instructions for the current CMake build system
Reviewers: ilya-biryukov
Subscribers: cfe-commits
Tags: #clang
Differential Revision: https://reviews.llvm.org/D58603
Modified:
clang-tools-extra/trunk/docs/README.txt
Modified: clang-tools-extra/trunk/docs/README.txt
URL: http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/docs/README.txt?rev=354779&r1=354778&r2=354779&view=diff
==============================================================================
--- clang-tools-extra/trunk/docs/README.txt (original)
+++ clang-tools-extra/trunk/docs/README.txt Mon Feb 25 05:03:44 2019
@@ -1,11 +1,10 @@
--------------------------------------------------------------
-Documentation for the tools of clang-tools-extra repo project
--------------------------------------------------------------
+----------------------------------
+Documentation in clang-tools-extra
+----------------------------------
-Sphinx and doxygen documentation is generated by executing make.
+To generate documentation in HTML format from files in clang-tools-extra/docs,
+build the docs-clang-tools-html target.
-Sphinx html files can be generated separately using make html.
+To generate documentation from the source code using Doxygen, build the
+doxygen-clang-tools target.
-Doxygen html files can also be generated using make doxygen.
-
-The generated documentation will be placed in _build/html.
More information about the cfe-commits
mailing list