This is an archive of the discontinued LLVM Phabricator instance.

Minor Sphinx documentation generation improvements
Needs ReviewPublic

Authored by t-tye on Jul 23 2021, 7:47 PM.

Details

Summary

Minor improvements to documentation for generating Sphinx documentation.

Minor improvements to CMake to generate Sphinx documentation.

Diff Detail

Event Timeline

t-tye created this revision.Jul 23 2021, 7:47 PM
t-tye requested review of this revision.Jul 23 2021, 7:47 PM
Herald added projects: Restricted Project, Restricted Project. · View Herald Transcript
MaskRay added inline comments.Jul 24 2021, 2:23 PM
lld/docs/sphinx_intro.rst
44

easy_install is deprecated https://packaging.python.org/discussions/pip-vs-easy-install/

We should just remove mention of it.

t-tye updated this revision to Diff 361484.Jul 24 2021, 7:13 PM

Remove mention of easy_install as deprecated. MacOS still appears to only come with easy_install.

t-tye added inline comments.Jul 24 2021, 7:17 PM
lld/docs/sphinx_intro.rst
44

Updated as suggested. MacOS still appears to use easy_install.

LGTM, as long as @MaskRay is satisfied with the changes around easy_install. If MacOS still uses it but we want to discourage it on Linux then I like the current wording.

llvm/docs/CMakeLists.txt
162

Could the above comment be replaced with the trailing "Slash indicates contents of" comment?

t-tye updated this revision to Diff 361841.Jul 26 2021, 4:06 PM

Replaced comment with a trailing "Slash indicates contents of" comment as suggested by @scott.linder.

t-tye added inline comments.Jul 26 2021, 4:07 PM
llvm/docs/CMakeLists.txt
162

Made change as suggested. This is now consistent with the other places that do the same thing.

MaskRay edited reviewers, added: tstellar; removed: MaskRay.Jul 28 2021, 8:44 PM