[all-commits] [llvm/llvm-project] 271a7b: [flang] Add new documentation main page

RichBarton-Arm via All-commits all-commits at lists.llvm.org
Fri Sep 11 06:22:24 PDT 2020


  Branch: refs/heads/master
  Home:   https://github.com/llvm/llvm-project
  Commit: 271a7bb144d3f51d29a465329c3614eaa15a6a3c
      https://github.com/llvm/llvm-project/commit/271a7bb144d3f51d29a465329c3614eaa15a6a3c
  Author: Richard Barton <richard.barton at arm.com>
  Date:   2020-09-11 (Fri, 11 Sep 2020)

  Changed paths:
    M flang/docs/ArrayComposition.md
    M flang/docs/BijectiveInternalNameUniquing.md
    M flang/docs/C++17.md
    M flang/docs/C++style.md
    M flang/docs/Calls.md
    M flang/docs/Character.md
    M flang/docs/ControlFlowGraph.md
    M flang/docs/Directives.md
    M flang/docs/Extensions.md
    M flang/docs/FortranForCProgrammers.md
    M flang/docs/FortranIR.md
    M flang/docs/IORuntimeInternals.md
    M flang/docs/ImplementingASemanticCheck.md
    M flang/docs/Intrinsics.md
    M flang/docs/LabelResolution.md
    M flang/docs/ModFiles.md
    A flang/docs/OpenMP-4.5-grammar.md
    R flang/docs/OpenMP-4.5-grammar.txt
    M flang/docs/OpenMP-semantics.md
    M flang/docs/OptionComparison.md
    M flang/docs/Overview.md
    M flang/docs/ParserCombinators.md
    M flang/docs/Parsing.md
    M flang/docs/Preprocessing.md
    M flang/docs/PullRequestChecklist.md
    M flang/docs/RuntimeDescriptor.md
    M flang/docs/Semantics.md
    M flang/docs/conf.py
    A flang/docs/f2018-grammar.md
    R flang/docs/f2018-grammar.txt
    A flang/docs/index.md

  Log Message:
  -----------
  [flang] Add new documentation main page

Add a new index page to be the Flang documentation mainpage instead of
Overview.md, which jumps straight into the compiler Design. The index file
needs to be in .rst format to use the toctree directive to create table of
contents.

Also use the sphinx_markdown_tables extension to generate html tables form
markdown.

A number of additional style changes to the existing docs were needed to make
this work well:
 * Convert all headings to the # style, which works better with toctree's
   titlesonly option. Ensure that there is only one top-level heading per
   document.
 * Add a title to documents that don't have one for rendering on the index.
 * Convert the grammar docs from .txt to .md. for better rendering
 * Fixed broken link to a section in another document - sphinx does not seem to
   support anchor links in markdown files.

Depends on D87226

Reviewed By: sameeranjoshi

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




More information about the All-commits mailing list