mirrors/llvm-project
0
0
Fork 0
mirror of https://github.com/llvm/llvm-project.git synced 2025-04-26 23:26:05 +00:00
Code Issues Projects 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.

95 lines
1.9 KiB
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 14:17:19 +01:00
# Welcome to Flang's documentation
[flang][docs] Update the top "doc" page * Added a note about "Classic Flang" * sorted entries in ToC Differential Revision: https://reviews.llvm.org/D120067
2022-02-17 16:53:57 +00:00
Flang is LLVM's Fortran frontend that can be found
[here](https://github.com/llvm/llvm-project/tree/main/flang). It is often
referred to as "LLVM Flang" to differentiate itself from ["Classic
Flang"](https://github.com/flang-compiler/flang) - these are two separate and
independent Fortran compilers. LLVM Flang is under active development. While it
is capable of generating executables for a number of examples, some
[flang][docs] Fix broken flang website (#80363) These are several fixes for the flang site. The look has been changed to match clang since flang, like clang, is a frontend. Some broken links were removed. Most fixes are to secton titles so the table of contents is generated correctly. A minor typo has been fixed.
2024-02-02 12:18:11 -07:00
functionality is still missing. See [Getting Involved](GettingInvolved) for tips
[flang][docs] Update the top "doc" page * Added a note about "Classic Flang" * sorted entries in ToC Differential Revision: https://reviews.llvm.org/D120067
2022-02-17 16:53:57 +00:00
on how to get in touch with us and to learn more about the current status.
[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 14:17:19 +01:00
[Documentation] Replace recommonmark by myst-parser (#65664) Recommonmark has been deprecated, then archived last year. This was tracked by: https://github.com/llvm/llvm-iwg/issues/30 See https://github.com/readthedocs/recommonmark This patch migrates all our doc to use myst Additional details for bot maintainers: https://discourse.llvm.org/t/maintenance-required-on-sphinx-build-bots/73612
2023-09-25 14:02:39 +02:00
```{eval-rst}
[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 14:17:19 +01:00
.. toctree::
:titlesonly:
ReleaseNotes
```
# Contributing to Flang
[Documentation] Replace recommonmark by myst-parser (#65664) Recommonmark has been deprecated, then archived last year. This was tracked by: https://github.com/llvm/llvm-iwg/issues/30 See https://github.com/readthedocs/recommonmark This patch migrates all our doc to use myst Additional details for bot maintainers: https://discourse.llvm.org/t/maintenance-required-on-sphinx-build-bots/73612
2023-09-25 14:02:39 +02:00
```{eval-rst}
[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 14:17:19 +01:00
.. toctree::
:titlesonly:
C++17
[flang][docs] Update the top "doc" page * Added a note about "Classic Flang" * sorted entries in ToC Differential Revision: https://reviews.llvm.org/D120067
2022-02-17 16:53:57 +00:00
C++style
[Flang][Docs] Add or exclude documents to the toc (#72302) This fixes all the warnings of the following type in the CI (https://lab.llvm.org/buildbot/#/builders/89/builds/50248/steps/5/logs/stdio) -> WARNING: document isn't included in any toctree.
2023-11-14 22:42:26 +00:00
DesignGuideline
[flang][docs] Update the top "doc" page * Added a note about "Classic Flang" * sorted entries in ToC Differential Revision: https://reviews.llvm.org/D120067
2022-02-17 16:53:57 +00:00
FortranForCProgrammers
GettingInvolved
[Docs] Add GettingStarted.md to index.md
2023-04-13 08:28:57 +05:30
GettingStarted
[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 14:17:19 +01:00
ImplementingASemanticCheck
[flang][docs] Update the top "doc" page * Added a note about "Classic Flang" * sorted entries in ToC Differential Revision: https://reviews.llvm.org/D120067
2022-02-17 16:53:57 +00:00
PullRequestChecklist
[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 14:17:19 +01:00
```
# Design Documents
[Documentation] Replace recommonmark by myst-parser (#65664) Recommonmark has been deprecated, then archived last year. This was tracked by: https://github.com/llvm/llvm-iwg/issues/30 See https://github.com/readthedocs/recommonmark This patch migrates all our doc to use myst Additional details for bot maintainers: https://discourse.llvm.org/t/maintenance-required-on-sphinx-build-bots/73612
2023-09-25 14:02:39 +02:00
```{eval-rst}
[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 14:17:19 +01:00
.. toctree::
:titlesonly:
[Flang][Docs] Add or exclude documents to the toc (#72302) This fixes all the warnings of the following type in the CI (https://lab.llvm.org/buildbot/#/builders/89/builds/50248/steps/5/logs/stdio) -> WARNING: document isn't included in any toctree.
2023-11-14 22:42:26 +00:00
Aliasing
AliasingAnalysisFIR
[flang][docs] Update the top "doc" page * Added a note about "Classic Flang" * sorted entries in ToC Differential Revision: https://reviews.llvm.org/D120067
2022-02-17 16:53:57 +00:00
ArrayComposition
[flang][RFC] Adding a design document for assumed-rank objects (#71959) This patch adds a document describing assumed-rank objects and the related features as well as how they will be implemented in Flang.
2023-11-17 11:10:15 +01:00
AssumedRank
[flang][docs] Update the top "doc" page * Added a note about "Classic Flang" * sorted entries in ToC Differential Revision: https://reviews.llvm.org/D120067
2022-02-17 16:53:57 +00:00
BijectiveInternalNameUniquing
Calls
Character
[Flang][Docs] Add or exclude documents to the toc (#72302) This fixes all the warnings of the following type in the CI (https://lab.llvm.org/buildbot/#/builders/89/builds/50248/steps/5/logs/stdio) -> WARNING: document isn't included in any toctree.
2023-11-14 22:42:26 +00:00
ComplexOperations
[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 14:17:19 +01:00
ControlFlowGraph
Directives
[flang][docs] Update the top "doc" page * Added a note about "Classic Flang" * sorted entries in ToC Differential Revision: https://reviews.llvm.org/D120067
2022-02-17 16:53:57 +00:00
DoConcurrent
[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 14:17:19 +01:00
Extensions
[Flang][Docs] Add or exclude documents to the toc (#72302) This fixes all the warnings of the following type in the CI (https://lab.llvm.org/buildbot/#/builders/89/builds/50248/steps/5/logs/stdio) -> WARNING: document isn't included in any toctree.
2023-11-14 22:42:26 +00:00
F202X
FIRArrayOperations
[Flang] Fix formatting for FIRLangRef.html Previously, FIRLangRef.md was incorrectly formatted. This was due to how FIRLangRef.md had no page header, and so the first entry would render incorrectly. This patch introduces a header file, which is prepended to the FIRLangRef before it becomes a HTML file. The header is currently brief but can be expanded upon at a later date if required. This formatting fix also means the index page can correctly generate a link to FIRLangRef.html and as such, this patch also removes FIRLangRef from the sidebar and adds it to the main list of links. Depends on D128650 Reviewed By: kiranchandramohan Differential Revision: https://reviews.llvm.org/D129186
2022-07-11 18:08:48 +00:00
FIRLangRef
[Flang] Generate documentation for compiler flags This patch aims to create a webpage to document Flang's command line options on https://flang.llvm.org/docs/ in a similar way to Clang's https://clang.llvm.org/docs/ClangCommandLineReference.html This is done by using clang_tablegen to generate an .rst file from Options.td (which is current shared with Clang) For this to work, ClangOptionDocEmitter.cpp was updated to allow specific Flang flags to be included, rather than bulk excluding clang flags. Note: Some headings in the generated documentation will incorrectly contain references to Clang, e.g. "Flags controlling the behaviour of Clang during compilation" This is because Options.td (Which is shared between both Clang and Flang) contains hard-coded DocBrief sections. I couldn't find a non-intrusive way to make this target-dependant, as such I've left this as is, and it will need revisiting later. Reviewed By: awarzynski Differential Revision: https://reviews.llvm.org/D129864
2022-07-22 16:40:50 +00:00
FlangCommandLineReference
[flang][docs] Update the top "doc" page * Added a note about "Classic Flang" * sorted entries in ToC Differential Revision: https://reviews.llvm.org/D120067
2022-02-17 16:53:57 +00:00
FlangDriver
[Flang][Docs] Add or exclude documents to the toc (#72302) This fixes all the warnings of the following type in the CI (https://lab.llvm.org/buildbot/#/builders/89/builds/50248/steps/5/logs/stdio) -> WARNING: document isn't included in any toctree.
2023-11-14 22:42:26 +00:00
FortranFeatureHistory
[flang][docs] Update the top "doc" page * Added a note about "Classic Flang" * sorted entries in ToC Differential Revision: https://reviews.llvm.org/D120067
2022-02-17 16:53:57 +00:00
FortranIR
FortranLLVMTestSuite
[Flang][Docs] Add or exclude documents to the toc (#72302) This fixes all the warnings of the following type in the CI (https://lab.llvm.org/buildbot/#/builders/89/builds/50248/steps/5/logs/stdio) -> WARNING: document isn't included in any toctree.
2023-11-14 22:42:26 +00:00
HighLevelFIR
[flang][docs] Update the top "doc" page * Added a note about "Classic Flang" * sorted entries in ToC Differential Revision: https://reviews.llvm.org/D120067
2022-02-17 16:53:57 +00:00
IORuntimeInternals
[Flang][Docs] Add or exclude documents to the toc (#72302) This fixes all the warnings of the following type in the CI (https://lab.llvm.org/buildbot/#/builders/89/builds/50248/steps/5/logs/stdio) -> WARNING: document isn't included in any toctree.
2023-11-14 22:42:26 +00:00
InternalProcedureTrampolines
[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 14:17:19 +01:00
Intrinsics
[flang] Document the Intrinsic Types Describe the built-in integer, real, complex and logical types implemented in flang, capturing the as-implemented characteristics. Differential Revision: https://reviews.llvm.org/D129658
2022-07-13 11:21:01 -07:00
IntrinsicTypes
[flang][docs] Update the top "doc" page * Added a note about "Classic Flang" * sorted entries in ToC Differential Revision: https://reviews.llvm.org/D120067
2022-02-17 16:53:57 +00:00
LabelResolution
ModFiles
[Flang][Docs] Add or exclude documents to the toc (#72302) This fixes all the warnings of the following type in the CI (https://lab.llvm.org/buildbot/#/builders/89/builds/50248/steps/5/logs/stdio) -> WARNING: document isn't included in any toctree.
2023-11-14 22:42:26 +00:00
OpenACC
[flang][docs] Fix broken flang website (#80363) These are several fixes for the flang site. The look has been changed to match clang since flang, like clang, is a frontend. Some broken links were removed. Most fixes are to secton titles so the table of contents is generated correctly. A minor typo has been fixed.
2024-02-02 12:18:11 -07:00
OpenACC-descriptor-management.md
[flang][docs] Update the top "doc" page * Added a note about "Classic Flang" * sorted entries in ToC Differential Revision: https://reviews.llvm.org/D120067
2022-02-17 16:53:57 +00:00
OpenMP-4.5-grammar.md
[Flang][MLIR][OpenMP] Create a deferred declare target marking process for Bridge.cpp (#78502) This patch seeks to create a process that happens on module finalization for OpenMP, in which a list of operations that had declare target directives applied to them and were not generated at the time of processing the original declare target directive are re-checked to apply the appropriate declare target semantics. This works by maintaining a vector of declare target related data inside of the FIR converter, in this case the symbol and the two relevant unsigned integers representing the enumerators. This vector is added to via a new function called from Bridge.cpp, insertDeferredDeclareTargets, which happens prior to the processing of the directive (similarly to getDeclareTargetFunctionDevice currently for requires), it effectively checks if the Operation the declare target directive is applied to currently exists, if it doesn't it appends to the vector. This is a seperate function to the processing of the declare target via the overloaded genOMP as we unfortunately do not have access to the list without passing it through every call, as the AbstractConverter we pass will not allow access to it (I've seen no other cases of casting it to a FirConverter, so I opted to not do that). The list is then processed at the end of the module in the finalizeOpenMPLowering function in Bridge by calling a new function markDelayedDeclareTargetFunctions which marks the latently generated operations. In certain cases, some still will not be generated, e.g. if an interface is defined, marked as declare target, but has no definition or usage in the module then it will not be emitted to the module, so due to these cases we must silently ignore when an operation has not been found via it's symbol. The main use-case for this (although, I imagine there is others) is for processing interfaces that have been declared in a module with a declare target directive but do not have their implementation defined in the same module. For example, inside of a seperate C++ module that will be linked in. In cases where the interface is called inside of a target region it'll be marked as used on device appropriately (although, realistically a user should explicitly mark it to match the corresponding definition), however, in cases where it's used in a non-clear manner through something like a function pointer passed to an external call we require this explicit marking, which this patch adds support for (currently will cause the compiler to crash). This patch also adds documentation on the declare target process and mechanisms within the compiler currently.
2024-03-05 17:27:16 +01:00
OpenMP-declare-target
[flang][docs] Fix a couple of warnings
2024-02-13 11:09:06 +00:00
OpenMP-descriptor-management
[flang][docs] Update the top "doc" page * Added a note about "Classic Flang" * sorted entries in ToC Differential Revision: https://reviews.llvm.org/D120067
2022-02-17 16:53:57 +00:00
OpenMP-semantics
[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 14:17:19 +01:00
OptionComparison
[flang][docs] Update the top "doc" page * Added a note about "Classic Flang" * sorted entries in ToC Differential Revision: https://reviews.llvm.org/D120067
2022-02-17 16:53:57 +00:00
Overview
[Flang][Docs] Add or exclude documents to the toc (#72302) This fixes all the warnings of the following type in the CI (https://lab.llvm.org/buildbot/#/builders/89/builds/50248/steps/5/logs/stdio) -> WARNING: document isn't included in any toctree.
2023-11-14 22:42:26 +00:00
ParameterizedDerivedTypes
[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 14:17:19 +01:00
ParserCombinators
[flang][docs] Update the top "doc" page * Added a note about "Classic Flang" * sorted entries in ToC Differential Revision: https://reviews.llvm.org/D120067
2022-02-17 16:53:57 +00:00
Parsing
[Flang][Docs] Add or exclude documents to the toc (#72302) This fixes all the warnings of the following type in the CI (https://lab.llvm.org/buildbot/#/builders/89/builds/50248/steps/5/logs/stdio) -> WARNING: document isn't included in any toctree.
2023-11-14 22:42:26 +00:00
PolymorphicEntities
[flang][docs] Update the top "doc" page * Added a note about "Classic Flang" * sorted entries in ToC Differential Revision: https://reviews.llvm.org/D120067
2022-02-17 16:53:57 +00:00
Preprocessing
[Flang][Docs] Add or exclude documents to the toc (#72302) This fixes all the warnings of the following type in the CI (https://lab.llvm.org/buildbot/#/builders/89/builds/50248/steps/5/logs/stdio) -> WARNING: document isn't included in any toctree.
2023-11-14 22:42:26 +00:00
ProcedurePointer
[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 14:17:19 +01:00
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 09:58:01 +05:30
RuntimeTypeInfo
[flang][docs] Update the top "doc" page * Added a note about "Classic Flang" * sorted entries in ToC Differential Revision: https://reviews.llvm.org/D120067
2022-02-17 16:53:57 +00:00
Semantics
f2018-grammar.md
[Flang][Docs] Add or exclude documents to the toc (#72302) This fixes all the warnings of the following type in the CI (https://lab.llvm.org/buildbot/#/builders/89/builds/50248/steps/5/logs/stdio) -> WARNING: document isn't included in any toctree.
2023-11-14 22:42:26 +00:00
fstack-arrays
[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 14:17:19 +01:00
```
# Indices and tables
[Documentation] Replace recommonmark by myst-parser (#65664) Recommonmark has been deprecated, then archived last year. This was tracked by: https://github.com/llvm/llvm-iwg/issues/30 See https://github.com/readthedocs/recommonmark This patch migrates all our doc to use myst Additional details for bot maintainers: https://discourse.llvm.org/t/maintenance-required-on-sphinx-build-bots/73612
2023-09-25 14:02:39 +02:00
```{eval-rst}
[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 14:17:19 +01:00
* :ref:`genindex`
* :ref:`search`
```
Reference in New Issue Copy Permalink