This is an archive of the discontinued LLVM Phabricator instance.

Differential D58603

Updated the documentation build instructions for the current CMake build system
ClosedPublic

Authored by gribozavr on Feb 25 2019, 3:23 AM.

Details

Reviewers
ilya-biryukov
Commits
rGcfa0d7a3581e: Updated the documentation build instructions for the current CMake build system
rCTE354779: Updated the documentation build instructions for the current CMake build system
rL354779: Updated the documentation build instructions for the current CMake build system

Diff Detail

Event Timeline

gribozavr created this revision.Feb 25 2019, 3:23 AM
Herald added a project: Restricted Project. · View Herald TranscriptFeb 25 2019, 3:23 AM
Harbormaster completed remote builds in B28471: Diff 188120.Feb 25 2019, 3:25 AM
ilya-biryukov added inline comments.Feb 25 2019, 4:42 AM
clang-tools-extra/docs/README.txt
5

NIT: maybe use an imperative form? Arguably looks more concise:

To generate documentation in HTML format execute the `docs-clang-tools-html` target.
6

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?)

ilya-biryukov marked an inline comment as done.Feb 25 2019, 4:44 AM
ilya-biryukov added inline comments.
clang-tools-extra/docs/README.txt
6

Ah, this is txt file. Ignore the comment please.

gribozavr updated this revision to Diff 188133.Feb 25 2019, 4:46 AM
gribozavr marked 2 inline comments as done.

.

Harbormaster completed remote builds in B28481: Diff 188133.Feb 25 2019, 4:46 AM
gribozavr added inline comments.Feb 25 2019, 4:50 AM
clang-tools-extra/docs/README.txt
6

This is a .txt...

ilya-biryukov accepted this revision.Feb 25 2019, 5:00 AM

LGTM

This revision is now accepted and ready to land.Feb 25 2019, 5:00 AM
Closed by commit rL354779: Updated the documentation build instructions for the current CMake build system (authored by gribozavr). · Explain WhyFeb 25 2019, 5:03 AM
This revision was automatically updated to reflect the committed changes.
Herald added a project: Restricted Project. · View Herald TranscriptFeb 25 2019, 5:03 AM
Herald added a subscriber: llvm-commits. · View Herald Transcript

Revision Contents

PathSize
clang-tools-extra/
docs/
15 lines

Diff 188120

clang-tools-extra/docs/README.txt

------------------------------------------------------------- ----------------------------------
Documentation for the tools of clang-tools-extra repo project Documentation in clang-tools-extra
------------------------------------------------------------- ----------------------------------
Sphinx and doxygen documentation is generated by executing make. You can generate documentation in HTML format from files in
ilya-biryukovUnsubmitted
Done
ReplyInline Actions

NIT: maybe use an imperative form? Arguably looks more concise:

To generate documentation in HTML format execute the `docs-clang-tools-html` target.
ilya-biryukov: NIT: maybe use an imperative form? Arguably looks more concise: ``` To generate documentation…
clang-tools-extra/docs by building the docs-clang-tools-html target.
ilya-biryukovUnsubmitted
Not Done
ReplyInline Actions

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?)

ilya-biryukov: Could we mark 'docs-clang-tools-html' in a way that would produce a monospace font? (Not sure…
ilya-biryukovUnsubmitted
Done
ReplyInline Actions

Ah, this is txt file. Ignore the comment please.

ilya-biryukov: Ah, this is txt file. Ignore the comment please.
gribozavrAuthorUnsubmitted
Done
ReplyInline Actions

This is a .txt...

gribozavr: This is a `.txt`...
Sphinx html files can be generated separately using make html. You can generate documentation from the source code using Doxygen by building
the doxygen-clang-tools target.
Doxygen html files can also be generated using make doxygen.
The generated documentation will be placed in _build/html.