[PATCH] D87242: [flang] Add new documentation main page

[Richard Barton via Phabricator via llvm-commits]

richard.barton.arm created this revision.
richard.barton.arm added reviewers: sscalpone, hans, sameeranjoshi.
Herald added subscribers: llvm-commits, aaron.ballman, jfb, arphaman.
Herald added a reviewer: DavidTruby.
Herald added a project: LLVM.
richard.barton.arm requested review of this revision.
Herald added a reviewer: jdoerfert.
Herald added a subscriber: sstefan1.

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 <https://reviews.llvm.org/D87226>


Repository:
  rG LLVM Github Monorepo

https://reviews.llvm.org/D87242

Files:
  flang/docs/ArrayComposition.md
  flang/docs/BijectiveInternalNameUniquing.md
  flang/docs/C++17.md
  flang/docs/C++style.md
  flang/docs/Calls.md
  flang/docs/Character.md
  flang/docs/ControlFlowGraph.md
  flang/docs/Directives.md
  flang/docs/Extensions.md
  flang/docs/FortranForCProgrammers.md
  flang/docs/IORuntimeInternals.md
  flang/docs/ImplementingASemanticCheck.md
  flang/docs/Intrinsics.md
  flang/docs/OpenMP-4.5-grammar.md
  flang/docs/OpenMP-4.5-grammar.txt
  flang/docs/OptionComparison.md
  flang/docs/ParserCombinators.md
  flang/docs/Preprocessing.md
  flang/docs/PullRequestChecklist.md
  flang/docs/RuntimeDescriptor.md
  flang/docs/conf.py
  flang/docs/f2018-grammar.md
  flang/docs/f2018-grammar.txt
  flang/docs/index.rst

-------------- next part --------------
A non-text attachment was scrubbed...
Name: D87242.290298.patch
Type: text/x-patch
Size: 46590 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20200907/ef58d911/attachment.bin>