diff options
Diffstat (limited to 'docs/README.txt')
| -rw-r--r-- | docs/README.txt | 15 |
1 files changed, 7 insertions, 8 deletions
diff --git a/docs/README.txt b/docs/README.txt index 4b607775..cebbf63b 100644 --- a/docs/README.txt +++ b/docs/README.txt @@ -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. |