maxjhandsome
/
llvm-project
forked from OSchip/llvm-project
1
0
Fork 0
Code Issues Pull Requests Packages Releases Wiki Activity
llvm-project/flang/docs/index.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

66 lines
924 B
Markdown
Raw Normal View History

[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
2020-09-11 21:17:19 +08:00
# Welcome to Flang's documentation
Flang is LLVM's Fortran frontend
```eval_rst
.. toctree::
:titlesonly:
ReleaseNotes
```
# Contributing to Flang
```eval_rst
.. toctree::
:titlesonly:
[Flang] Add GettingInvolved documentation page and sidebar. Adds a new GettingInvolved page to documentation which provides details about mailing list, chats and calls. Adds a sidebar page which provides common links on all documentation pages. The links include: - Getting Started - Getting Involved - Github Repository - Bug Reports - Code Review Depends on https://reviews.llvm.org/D87242 Reviewed By: richard.barton.arm Differential Revision: https://reviews.llvm.org/D87270
2020-09-13 19:54:34 +08:00
GettingInvolved
[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
2020-09-11 21:17:19 +08:00
FortranForCProgrammers
C++style
C++17
PullRequestChecklist
ImplementingASemanticCheck
```
# Design Documents
```eval_rst
.. toctree::
:titlesonly:
Overview
Preprocessing
Parsing
LabelResolution
ModFiles
Semantics
OpenMP-semantics
ControlFlowGraph
FortranIR
IORuntimeInternals
f2018-grammar.md
OpenMP-4.5-grammar.md
Directives
Extensions
Intrinsics
OptionComparison
ParserCombinators
RuntimeDescriptor
[Flang][Docs] Fix warnings when building docs. Following warning were seen with recommonmark(0.5.0) and sphinx(1.8.5). `parser.py:75: UserWarning: Container node skipped: type=document warn("Container node skipped: type={0}".format(mdnode.t))` The warnings are due to an issue in recommonmark's(a python package) older versions. A better solution is to use the latest version of recommonmark(>=0.6.0) to avoid these issue in the first place. This patch fixes the warnings for older versions. Reviewed By: jdoerfert Differential Revision: https://reviews.llvm.org/D91117
2020-11-10 12:28:01 +08:00
RuntimeTypeInfo
[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
2020-09-11 21:17:19 +08:00
Calls
Character
ArrayComposition
BijectiveInternalNameUniquing
[flang] Document DO CONCURRENT's problems (NFC) Differential Revision: https://reviews.llvm.org/D86556
2020-08-26 00:43:16 +08:00
DoConcurrent
[flang][docs] Initial documentation for the Fortran LLVM Test Suite. Describes how to run the Fortran LLVM Test Suite, specifically the external SPEC CPU 2017 Fortran tests. Reviewed By: rovka Differential Revision: https://reviews.llvm.org/D102877
2021-05-27 04:54:16 +08:00
FortranLLVMTestSuite
[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
2020-09-11 21:17:19 +08:00
```
# Indices and tables
```eval_rst
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
```