[PATCH] D58603: Updated the documentation build instructions for the current CMake build system

Ilya Biryukov via Phabricator via cfe-commits cfe-commits at lists.llvm.org
Mon Feb 25 04:42:49 PST 2019


ilya-biryukov added inline comments.


================
Comment at: clang-tools-extra/docs/README.txt:5
 
-Sphinx and doxygen documentation is generated by executing make.
+You can generate documentation in HTML format from files in
+clang-tools-extra/docs by building the docs-clang-tools-html target.
----------------
NIT: maybe use an imperative form? Arguably looks more concise:
```
To generate documentation in HTML format execute the `docs-clang-tools-html` target.
```


================
Comment at: clang-tools-extra/docs/README.txt:6
+You can generate documentation in HTML format from files in
+clang-tools-extra/docs by building the docs-clang-tools-html target.
 
----------------
Could we mark 'docs-clang-tools-html' in a way that would produce a monospace font?
(Not sure how this is done in Sphinx, backticks?)


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D58603/new/

https://reviews.llvm.org/D58603





More information about the cfe-commits mailing list