[all-commits] [llvm/llvm-project] bc9cdf: [FLANG] Pick `.md` files when building sphinx docu...

sameeranjoshi via All-commits all-commits at lists.llvm.org
Mon Aug 24 09:41:44 PDT 2020


  Branch: refs/heads/master
  Home:   https://github.com/llvm/llvm-project
  Commit: bc9cdfa12bde46c77bcc6450707f2714133e9b2f
      https://github.com/llvm/llvm-project/commit/bc9cdfa12bde46c77bcc6450707f2714133e9b2f
  Author: Sameeran joshi <joshisameeran17 at gmail.com>
  Date:   2020-08-24 (Mon, 24 Aug 2020)

  Changed paths:
    M flang/README.md
    M flang/docs/conf.py

  Log Message:
  -----------
  [FLANG] Pick `.md` files when building sphinx documentation.

Need to build sphinx using below flags to Cmake
`-DLLVM_ENABLE_SPHINX=ON -DSPHINX_WARNINGS_AS_ERRORS=OFF`.
Generate html docs using cmake target
`docs-flang-html`
Generated html files should be at `build/tools/flang/docs/html`.
Patch in series from the dicussion on review
https://reviews.llvm.org/D85828

After this patch the markdown docmentation must be written using guide in-
`llvm/docs/MarkdownQuickstartTemplate.md`

Reviewed By: sscalpone

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




More information about the All-commits mailing list