HomePhabricator

[flang] Add new documentation main page

Authored by richard.barton.arm on Sep 11 2020, 6:17 AM.

Description

[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

Details

Committed
richard.barton.armSep 11 2020, 6:19 AM
Reviewer
sameeranjoshi
Differential Revision
D87242: [flang] Add new documentation main page
Parents
rG9fda213ac0e2: [ARM] Update arm-storebytesmerge.ll test. NFC
Branches
Unknown
Tags
Unknown