[all-commits] [llvm/llvm-project] 87d8ae: [clang][cmake] Include generated rst files in html...

[tstellar via All-commits]

  Branch: refs/heads/master
  Home:   https://github.com/llvm/llvm-project
  Commit: 87d8ae700b80d58d69bb92b601f946f02f089398
      https://github.com/llvm/llvm-project/commit/87d8ae700b80d58d69bb92b601f946f02f089398
  Author: Tom Stellard <tstellar at redhat.com>
  Date:   2020-03-05 (Thu, 05 Mar 2020)

  Changed paths:
    R clang/docs/AttributeReference.rst
    M clang/docs/CMakeLists.txt
    M llvm/cmake/modules/AddSphinxTarget.cmake

  Log Message:
  -----------
  [clang][cmake] Include generated rst files in html built by docs-clang-html target

Summary:
This is an attempt to simply the process of building the clang
documentation, which should help avoid some of the recent issues we've
had generating the documentation for the website.

The html documentation for clang is generated by sphinx from the
reStructuredText (rst) files we have in the clang/docs directory.
There are also some rst files that need to be generated by TableGen,
before they can be passed to sphinx.  Prior to this patch we were not
generating those rst files as part with the build system and they had to be
generated manually.

This patch enables the automatic generation of these rst files, but
since they are generated at build time the cannot be placed in the
clang/docs directory and must go into the cmake build directory.

Unfortunately sphinx does not currently support multiple source
directories[1], so in order to be able to generate the full
documentation, we need to work around this by copying the
rst files from the clang/docs into the  build directory before
generating the html documentation.

[1] https://github.com/sphinx-doc/sphinx/issues/3132

Reviewers: rsmith, aaron.ballman, beanz, smeenai, phosek, compnerd, mgorny, delcypher

Reviewed By: mgorny, delcypher

Subscribers: delcypher, merge_guards_bot, mgorny, llvm-commits, cfe-commits

Tags: #clang, #llvm

Differential Revision: https://reviews.llvm.org/D72875