[PATCH] D86131: [FLANG] Pick `.md` files when building sphinx documentation.

Hans Wennborg via Phabricator via llvm-commits llvm-commits at lists.llvm.org
Mon Aug 31 04:57:03 PDT 2020


hans added a comment.

I tried building the Flang docs with this applied, and they build fine, but show up empty in my web browser.

Looking at the generated Overview.html, it seems to be because of the comment header at the top, which looks like this in HTML:

    <!--===- docs/Overview.md <p>Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
  See https://llvm.org/LICENSE.txt for license information.
  SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception</p>
  <p>–></p>

It appears that the HTML comment is never terminated, because the `-->` has been turned into `–>` by the tool.

I would suggest dropping the comment headers from the docs; other LLVM projects don't seem to have them. Or if they're considered important, maybe try one of the other techniques in https://stackoverflow.com/questions/4823468/comments-in-markdown


Repository:
  rG LLVM Github Monorepo

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

https://reviews.llvm.org/D86131



More information about the llvm-commits mailing list