mirror of
https://github.com/intel/llvm.git
synced 2026-01-20 01:58:44 +08:00
[Flang] Fix release blocker issue #46931 related to documentation.
Summary: Fixes bug : https://bugs.llvm.org/show_bug.cgi?id=46931 This commit add a new flag -DLLVM_ENABLE_SPHINX=ON to cmake command to generate sphinx documentation, along with new cmake targets `docs-flang-html`. `ninja docs-flang-html` - generates sphinx documentation. Generated release notes are present in <builddir>/tools/flang/docs/html/ folder. Reviewers: richard.barton.arm, DavidTruby Tags: #flang Differential Revision: https://reviews.llvm.org/D85470
This commit is contained in:
sameeran joshi
committed by
Sameeran joshi
Sameeran joshi
parent
667843cc07
commit
2fc86ccdd2
96
flang/docs/ReleaseNotes.rst
Normal file
96
flang/docs/ReleaseNotes.rst
Normal file
@@ -0,0 +1,96 @@
|
||||
========================================
|
||||
Flang 11.0.0 (In-Progress) Release Notes
|
||||
========================================
|
||||
|
||||
.. contents::
|
||||
:local:
|
||||
:depth: 2
|
||||
|
||||
.. warning::
|
||||
|
||||
These are in-progress notes for the upcoming LLVM 11.0.0 release.
|
||||
Release notes for previous releases can be found on
|
||||
`the Download Page <https://releases.llvm.org/download.html>`_.
|
||||
|
||||
Introduction
|
||||
============
|
||||
|
||||
This document contains the release notes for the Flang Fortran
|
||||
frontend, part of the LLVM Compiler Infrastructure, release 11.0.0. Here we
|
||||
describe the status of Flang in some detail, including major
|
||||
improvements from the previous release and new feature work. For the
|
||||
general LLVM release notes, see `the LLVM
|
||||
documentation <https://llvm.org/docs/ReleaseNotes.html>`_. All LLVM
|
||||
releases may be downloaded from the `LLVM releases web
|
||||
site <https://llvm.org/releases/>`_.
|
||||
|
||||
Note that if you are reading this file from a Git checkout, this document
|
||||
applies to the *next* release, not
|
||||
the current one. To see the release notes for a specific release, please
|
||||
see the `releases page <https://llvm.org/releases/>`_.
|
||||
|
||||
Known Issues
|
||||
============
|
||||
|
||||
These are issues that couldn't be fixed before the release. See the bug reports for the latest status.
|
||||
|
||||
- ...
|
||||
|
||||
Introducing Flang
|
||||
=================
|
||||
|
||||
Flang is LLVM's Fortran front end and is new for the LLVM 11 release.
|
||||
|
||||
Flang is still a work in progress for this release and is included for
|
||||
experimentation and feedback.
|
||||
|
||||
Flang status
|
||||
------------
|
||||
|
||||
Flang is able to parse a comprehensive subset of the Fortran language
|
||||
and check it for correctness. Flang is not yet able to generate LLVM IR for
|
||||
the source code and thus is unable to compile a running binary.
|
||||
|
||||
Flang is able to unparse the input source code into a canonical form and emit
|
||||
it to allow testing. Flang can also invoke an external Fortran compiler on this
|
||||
canonical input.
|
||||
|
||||
Flang's parser has comprehensive support for:
|
||||
- Fortran 2018
|
||||
- OpenMP 4.5
|
||||
- OpenACC 3.0
|
||||
|
||||
Major missing features
|
||||
----------------------
|
||||
|
||||
- Flang is not supported on Windows platforms.
|
||||
|
||||
Using Flang
|
||||
===========
|
||||
|
||||
Usage: ``flang hello.f90 -o hello.bin``
|
||||
|
||||
Flang will parse the Fortran file ``hello.f90`` then unparse it to a canonical
|
||||
Fortran source file. Flang will then invoke an external Fortran compiler to
|
||||
compile this source file and link it, placing the resulting executable
|
||||
in ``hello.bin``.
|
||||
|
||||
To specify the external Fortran compiler, set the ``F18_FC`` environment
|
||||
variable to the name of the compiler binary and ensure it is on your ``PATH``.
|
||||
The default value for ``F18_FC`` is ``gfortran``.
|
||||
|
||||
When invoked with no source input, Flang will wait for input on standard in.
|
||||
When invoked in this way, Flang performs the same actions as if called with
|
||||
``-fdebug-measure-parse-tree -funparse`` and does not invoke ``F18_FC``.
|
||||
|
||||
For a full list of options that Flang supports, run ``flang --help``.
|
||||
|
||||
Additional Information
|
||||
======================
|
||||
|
||||
Flang's documentation is located in the ``flang/docs/`` directory in
|
||||
the LLVM monorepo.
|
||||
|
||||
If you have any questions or comments about Flang, please feel free to
|
||||
contact us via the `mailing
|
||||
list <https://lists.llvm.org/mailman/listinfo/flang-dev>`_.
|
||||
112
flang/docs/_static/llvm.css
vendored
Normal file
112
flang/docs/_static/llvm.css
vendored
Normal file
@@ -0,0 +1,112 @@
|
||||
/*
|
||||
* LLVM documentation style sheet
|
||||
*/
|
||||
|
||||
/* Common styles */
|
||||
.body { color: black; background: white; margin: 0 0 0 0 }
|
||||
|
||||
/* No borders on image links */
|
||||
a:link img, a:visited img { border-style: none }
|
||||
|
||||
address img { float: right; width: 88px; height: 31px; }
|
||||
address { clear: right; }
|
||||
|
||||
table { text-align: center; border: 2px solid black;
|
||||
border-collapse: collapse; margin-top: 1em; margin-left: 1em;
|
||||
margin-right: 1em; margin-bottom: 1em; }
|
||||
tr, td { border: 2px solid gray; padding: 4pt 4pt 2pt 2pt; }
|
||||
th { border: 2px solid gray; font-weight: bold; font-size: 105%;
|
||||
background: url("lines.gif");
|
||||
font-family: "Georgia,Palatino,Times,Roman,SanSerif";
|
||||
text-align: center; vertical-align: middle; }
|
||||
/*
|
||||
* Documentation
|
||||
*/
|
||||
/* Common for title and header */
|
||||
.doc_title, .doc_section, .doc_subsection, h1, h2, h3 {
|
||||
color: black; background: url("lines.gif");
|
||||
font-family: "Georgia,Palatino,Times,Roman,SanSerif"; font-weight: bold;
|
||||
border-width: 1px;
|
||||
border-style: solid none solid none;
|
||||
text-align: center;
|
||||
vertical-align: middle;
|
||||
padding-left: 8pt;
|
||||
padding-top: 1px;
|
||||
padding-bottom: 2px
|
||||
}
|
||||
|
||||
h1, .doc_title, .title { text-align: left; font-size: 25pt }
|
||||
|
||||
h2, .doc_section { text-align: center; font-size: 22pt;
|
||||
margin: 20pt 0pt 5pt 0pt; }
|
||||
|
||||
h3, .doc_subsection { width: 75%;
|
||||
text-align: left; font-size: 12pt;
|
||||
padding: 4pt 4pt 4pt 4pt;
|
||||
margin: 1.5em 0.5em 0.5em 0.5em }
|
||||
|
||||
h4, .doc_subsubsection { margin: 2.0em 0.5em 0.5em 0.5em;
|
||||
font-weight: bold; font-style: oblique;
|
||||
border-bottom: 1px solid #999999; font-size: 12pt;
|
||||
width: 75%; }
|
||||
|
||||
.doc_author { text-align: left; font-weight: bold; padding-left: 20pt }
|
||||
.doc_text { text-align: left; padding-left: 20pt; padding-right: 10pt }
|
||||
|
||||
.doc_footer { text-align: left; padding: 0 0 0 0 }
|
||||
|
||||
.doc_hilite { color: blue; font-weight: bold; }
|
||||
|
||||
.doc_table { text-align: center; width: 90%;
|
||||
padding: 1px 1px 1px 1px; border: 1px; }
|
||||
|
||||
.doc_warning { color: red; font-weight: bold }
|
||||
|
||||
/* <div class="doc_code"> would use this class, and <div> adds more padding */
|
||||
.doc_code, .literal-block
|
||||
{ border: solid 1px gray; background: #eeeeee;
|
||||
margin: 0 1em 0 1em;
|
||||
padding: 0 1em 0 1em;
|
||||
display: table;
|
||||
}
|
||||
|
||||
blockquote pre {
|
||||
padding: 1em 2em 1em 1em;
|
||||
border: solid 1px gray;
|
||||
background: #eeeeee;
|
||||
margin: 0 1em 0 1em;
|
||||
display: table;
|
||||
}
|
||||
|
||||
h2+div, h2+p {text-align: left; padding-left: 20pt; padding-right: 10pt;}
|
||||
h3+div, h3+p {text-align: left; padding-left: 20pt; padding-right: 10pt;}
|
||||
h4+div, h4+p {text-align: left; padding-left: 20pt; padding-right: 10pt;}
|
||||
|
||||
/* It is preferable to use <pre class="doc_code"> everywhere instead of the
|
||||
* <div class="doc_code"><pre>...</ptr></div> construct.
|
||||
*
|
||||
* Once all docs use <pre> for code regions, this style can be merged with the
|
||||
* one above, and we can drop the [pre] qualifier.
|
||||
*/
|
||||
pre.doc_code, .literal-block { padding: 1em 2em 1em 1em }
|
||||
|
||||
.doc_notes { background: #fafafa; border: 1px solid #cecece;
|
||||
display: table; padding: 0 1em 0 .1em }
|
||||
|
||||
table.layout { text-align: left; border: none; border-collapse: collapse;
|
||||
padding: 4px 4px 4px 4px; }
|
||||
tr.layout, td.layout, td.left, td.right
|
||||
{ border: none; padding: 4pt 4pt 2pt 2pt; vertical-align: top; }
|
||||
td.left { text-align: left }
|
||||
td.right { text-align: right }
|
||||
th.layout { border: none; font-weight: bold; font-size: 105%;
|
||||
text-align: center; vertical-align: middle; }
|
||||
|
||||
/* Left align table cell */
|
||||
.td_left { border: 2px solid gray; text-align: left; }
|
||||
|
||||
/* ReST-specific */
|
||||
.title { margin-top: 0 }
|
||||
.topic-title{ display: none }
|
||||
div.contents ul { list-style-type: decimal }
|
||||
.toc-backref { color: black; text-decoration: none; }
|
||||
23
flang/docs/_themes/llvm-theme/layout.html
vendored
Normal file
23
flang/docs/_themes/llvm-theme/layout.html
vendored
Normal file
@@ -0,0 +1,23 @@
|
||||
{#
|
||||
sphinxdoc/layout.html
|
||||
~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Sphinx layout template for the sphinxdoc theme.
|
||||
|
||||
:copyright: Copyright 2007-2010 by the Sphinx team, see AUTHORS.
|
||||
:license: BSD, see LICENSE for details.
|
||||
#}
|
||||
{% extends "basic/layout.html" %}
|
||||
|
||||
{% block relbar1 %}
|
||||
<div class="logo">
|
||||
<a href="{{ pathto('index') }}">
|
||||
<img src="{{pathto("_static/logo.png", 1) }}"
|
||||
alt="LLVM Logo" width="250" height="88"/></a>
|
||||
</div>
|
||||
{{ super() }}
|
||||
{% endblock %}
|
||||
|
||||
{# put the sidebar before the body #}
|
||||
{% block sidebar1 %}{{ sidebar() }}{% endblock %}
|
||||
{% block sidebar2 %}{% endblock %}
|
||||
BIN
flang/docs/_themes/llvm-theme/static/contents.png
vendored
Normal file
BIN
flang/docs/_themes/llvm-theme/static/contents.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 202 B |
371
flang/docs/_themes/llvm-theme/static/llvm-theme.css
vendored
Normal file
371
flang/docs/_themes/llvm-theme/static/llvm-theme.css
vendored
Normal file
@@ -0,0 +1,371 @@
|
||||
/*
|
||||
* sphinxdoc.css_t
|
||||
* ~~~~~~~~~~~~~~~
|
||||
*
|
||||
* Sphinx stylesheet -- sphinxdoc theme. Originally created by
|
||||
* Armin Ronacher for Werkzeug.
|
||||
*
|
||||
* :copyright: Copyright 2007-2010 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
|
||||
@import url("basic.css");
|
||||
|
||||
/* -- page layout ----------------------------------------------------------- */
|
||||
|
||||
body {
|
||||
font-family: 'Lucida Grande', 'Lucida Sans Unicode', 'Geneva',
|
||||
'Verdana', sans-serif;
|
||||
font-size: 14px;
|
||||
line-height: 150%;
|
||||
text-align: center;
|
||||
background-color: #BFD1D4;
|
||||
color: black;
|
||||
padding: 0;
|
||||
border: 1px solid #aaa;
|
||||
margin: 0px 80px 0px 80px;
|
||||
min-width: 740px;
|
||||
}
|
||||
|
||||
div.logo {
|
||||
background-color: white;
|
||||
text-align: left;
|
||||
padding: 10px 10px 15px 15px;
|
||||
}
|
||||
|
||||
div.document {
|
||||
background-color: white;
|
||||
text-align: left;
|
||||
background-image: url(contents.png);
|
||||
background-repeat: repeat-x;
|
||||
}
|
||||
|
||||
div.bodywrapper {
|
||||
margin: 0 240px 0 0;
|
||||
border-right: 1px solid #ccc;
|
||||
}
|
||||
|
||||
div.body {
|
||||
margin: 0;
|
||||
padding: 0.5em 20px 20px 20px;
|
||||
max-width: 1000px;
|
||||
}
|
||||
|
||||
div.related {
|
||||
font-size: 1em;
|
||||
}
|
||||
|
||||
div.related ul {
|
||||
background-image: url(navigation.png);
|
||||
height: 2em;
|
||||
border-top: 1px solid #ddd;
|
||||
border-bottom: 1px solid #ddd;
|
||||
}
|
||||
|
||||
div.related ul li {
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
height: 2em;
|
||||
float: left;
|
||||
}
|
||||
|
||||
div.related ul li.right {
|
||||
float: right;
|
||||
margin-right: 5px;
|
||||
}
|
||||
|
||||
div.related ul li a {
|
||||
margin: 0;
|
||||
padding: 0 5px 0 5px;
|
||||
line-height: 1.75em;
|
||||
color: #EE9816;
|
||||
}
|
||||
|
||||
div.related ul li a:hover {
|
||||
color: #3CA8E7;
|
||||
}
|
||||
|
||||
div.sphinxsidebarwrapper {
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
div.sphinxsidebar {
|
||||
margin: 0;
|
||||
padding: 0.5em 15px 15px 0;
|
||||
width: 210px;
|
||||
float: right;
|
||||
font-size: 1em;
|
||||
text-align: left;
|
||||
}
|
||||
|
||||
div.sphinxsidebar h3, div.sphinxsidebar h4 {
|
||||
margin: 1em 0 0.5em 0;
|
||||
font-size: 1em;
|
||||
padding: 0.1em 0 0.1em 0.5em;
|
||||
color: white;
|
||||
border: 1px solid #86989B;
|
||||
background-color: #AFC1C4;
|
||||
}
|
||||
|
||||
div.sphinxsidebar h3 a {
|
||||
color: white;
|
||||
}
|
||||
|
||||
div.sphinxsidebar ul {
|
||||
padding-left: 1.5em;
|
||||
margin-top: 7px;
|
||||
padding: 0;
|
||||
line-height: 130%;
|
||||
}
|
||||
|
||||
div.sphinxsidebar ul ul {
|
||||
margin-left: 20px;
|
||||
}
|
||||
|
||||
div.footer {
|
||||
background-color: #E3EFF1;
|
||||
color: #86989B;
|
||||
padding: 3px 8px 3px 0;
|
||||
clear: both;
|
||||
font-size: 0.8em;
|
||||
text-align: right;
|
||||
}
|
||||
|
||||
div.footer a {
|
||||
color: #86989B;
|
||||
text-decoration: underline;
|
||||
}
|
||||
|
||||
/* -- body styles ----------------------------------------------------------- */
|
||||
|
||||
p {
|
||||
margin: 0.8em 0 0.5em 0;
|
||||
}
|
||||
|
||||
a {
|
||||
color: #CA7900;
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
a:hover {
|
||||
color: #2491CF;
|
||||
}
|
||||
|
||||
div.body p a{
|
||||
text-decoration: underline;
|
||||
}
|
||||
|
||||
h1 {
|
||||
margin: 0;
|
||||
padding: 0.7em 0 0.3em 0;
|
||||
font-size: 1.5em;
|
||||
color: #11557C;
|
||||
}
|
||||
|
||||
h2 {
|
||||
margin: 1.3em 0 0.2em 0;
|
||||
font-size: 1.35em;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
h3 {
|
||||
margin: 1em 0 -0.3em 0;
|
||||
font-size: 1.2em;
|
||||
}
|
||||
|
||||
h3 a:hover {
|
||||
text-decoration: underline;
|
||||
}
|
||||
|
||||
div.body h1 a, div.body h2 a, div.body h3 a, div.body h4 a, div.body h5 a, div.body h6 a {
|
||||
color: black!important;
|
||||
}
|
||||
|
||||
div.body h1,
|
||||
div.body h2,
|
||||
div.body h3,
|
||||
div.body h4,
|
||||
div.body h5,
|
||||
div.body h6 {
|
||||
background-color: #f2f2f2;
|
||||
font-weight: normal;
|
||||
color: #20435c;
|
||||
border-bottom: 1px solid #ccc;
|
||||
margin: 20px -20px 10px -20px;
|
||||
padding: 3px 0 3px 10px;
|
||||
}
|
||||
|
||||
div.body h1 { margin-top: 0; font-size: 200%; }
|
||||
div.body h2 { font-size: 160%; }
|
||||
div.body h3 { font-size: 140%; }
|
||||
div.body h4 { font-size: 120%; }
|
||||
div.body h5 { font-size: 110%; }
|
||||
div.body h6 { font-size: 100%; }
|
||||
|
||||
h1 a.anchor, h2 a.anchor, h3 a.anchor, h4 a.anchor, h5 a.anchor, h6 a.anchor {
|
||||
display: none;
|
||||
margin: 0 0 0 0.3em;
|
||||
padding: 0 0.2em 0 0.2em;
|
||||
color: #aaa!important;
|
||||
}
|
||||
|
||||
h1:hover a.anchor, h2:hover a.anchor, h3:hover a.anchor, h4:hover a.anchor,
|
||||
h5:hover a.anchor, h6:hover a.anchor {
|
||||
display: inline;
|
||||
}
|
||||
|
||||
h1 a.anchor:hover, h2 a.anchor:hover, h3 a.anchor:hover, h4 a.anchor:hover,
|
||||
h5 a.anchor:hover, h6 a.anchor:hover {
|
||||
color: #777;
|
||||
background-color: #eee;
|
||||
}
|
||||
|
||||
a.headerlink {
|
||||
color: #c60f0f!important;
|
||||
font-size: 1em;
|
||||
margin-left: 6px;
|
||||
padding: 0 4px 0 4px;
|
||||
text-decoration: none!important;
|
||||
}
|
||||
|
||||
a.headerlink:hover {
|
||||
background-color: #ccc;
|
||||
color: white!important;
|
||||
}
|
||||
|
||||
cite, code, tt {
|
||||
font-family: 'Consolas', 'Deja Vu Sans Mono',
|
||||
'Bitstream Vera Sans Mono', monospace;
|
||||
font-size: 0.95em;
|
||||
}
|
||||
|
||||
:not(a.reference) > tt {
|
||||
background-color: #f2f2f2;
|
||||
border-bottom: 1px solid #ddd;
|
||||
color: #333;
|
||||
}
|
||||
|
||||
tt.descname, tt.descclassname, tt.xref {
|
||||
border: 0;
|
||||
}
|
||||
|
||||
hr {
|
||||
border: 1px solid #abc;
|
||||
margin: 2em;
|
||||
}
|
||||
|
||||
p a tt {
|
||||
border: 0;
|
||||
color: #CA7900;
|
||||
}
|
||||
|
||||
p a tt:hover {
|
||||
color: #2491CF;
|
||||
}
|
||||
|
||||
a tt {
|
||||
border: none;
|
||||
}
|
||||
|
||||
pre {
|
||||
font-family: 'Consolas', 'Deja Vu Sans Mono',
|
||||
'Bitstream Vera Sans Mono', monospace;
|
||||
font-size: 0.95em;
|
||||
line-height: 120%;
|
||||
padding: 0.5em;
|
||||
border: 1px solid #ccc;
|
||||
background-color: #f8f8f8;
|
||||
}
|
||||
|
||||
pre a {
|
||||
color: inherit;
|
||||
text-decoration: underline;
|
||||
}
|
||||
|
||||
td.linenos pre {
|
||||
padding: 0.5em 0;
|
||||
}
|
||||
|
||||
div.quotebar {
|
||||
background-color: #f8f8f8;
|
||||
max-width: 250px;
|
||||
float: right;
|
||||
padding: 2px 7px;
|
||||
border: 1px solid #ccc;
|
||||
}
|
||||
|
||||
div.topic {
|
||||
background-color: #f8f8f8;
|
||||
}
|
||||
|
||||
table {
|
||||
border-collapse: collapse;
|
||||
margin: 0 -0.5em 0 -0.5em;
|
||||
}
|
||||
|
||||
table td, table th {
|
||||
padding: 0.2em 0.5em 0.2em 0.5em;
|
||||
}
|
||||
|
||||
div.admonition, div.warning {
|
||||
font-size: 0.9em;
|
||||
margin: 1em 0 1em 0;
|
||||
border: 1px solid #86989B;
|
||||
background-color: #f7f7f7;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
div.admonition p, div.warning p {
|
||||
margin: 0.5em 1em 0.5em 1em;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
div.admonition pre, div.warning pre {
|
||||
margin: 0.4em 1em 0.4em 1em;
|
||||
}
|
||||
|
||||
div.admonition p.admonition-title,
|
||||
div.warning p.admonition-title {
|
||||
margin: 0;
|
||||
padding: 0.1em 0 0.1em 0.5em;
|
||||
color: white;
|
||||
border-bottom: 1px solid #86989B;
|
||||
font-weight: bold;
|
||||
background-color: #AFC1C4;
|
||||
}
|
||||
|
||||
div.warning {
|
||||
border: 1px solid #940000;
|
||||
}
|
||||
|
||||
div.warning p.admonition-title {
|
||||
background-color: #CF0000;
|
||||
border-bottom-color: #940000;
|
||||
}
|
||||
|
||||
div.admonition ul, div.admonition ol,
|
||||
div.warning ul, div.warning ol {
|
||||
margin: 0.1em 0.5em 0.5em 3em;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
div.versioninfo {
|
||||
margin: 1em 0 0 0;
|
||||
border: 1px solid #ccc;
|
||||
background-color: #DDEAF0;
|
||||
padding: 8px;
|
||||
line-height: 1.3em;
|
||||
font-size: 0.9em;
|
||||
}
|
||||
|
||||
.viewcode-back {
|
||||
font-family: 'Lucida Grande', 'Lucida Sans Unicode', 'Geneva',
|
||||
'Verdana', sans-serif;
|
||||
}
|
||||
|
||||
div.viewcode-block:target {
|
||||
background-color: #f4debf;
|
||||
border-top: 1px solid #ac9;
|
||||
border-bottom: 1px solid #ac9;
|
||||
}
|
||||
BIN
flang/docs/_themes/llvm-theme/static/logo.png
vendored
Normal file
BIN
flang/docs/_themes/llvm-theme/static/logo.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 9.6 KiB |
BIN
flang/docs/_themes/llvm-theme/static/navigation.png
vendored
Normal file
BIN
flang/docs/_themes/llvm-theme/static/navigation.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 218 B |
4
flang/docs/_themes/llvm-theme/theme.conf
vendored
Normal file
4
flang/docs/_themes/llvm-theme/theme.conf
vendored
Normal file
@@ -0,0 +1,4 @@
|
||||
[theme]
|
||||
inherit = basic
|
||||
stylesheet = llvm-theme.css
|
||||
pygments_style = friendly
|
||||
252
flang/docs/conf.py
Normal file
252
flang/docs/conf.py
Normal file
@@ -0,0 +1,252 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Flang documentation build configuration file.
|
||||
#
|
||||
# This file is execfile()d with the current directory set to its containing dir.
|
||||
#
|
||||
# Note that not all possible configuration values are present in this
|
||||
# autogenerated file.
|
||||
#
|
||||
# All configuration values have a default; values that are commented out
|
||||
# serve to show the default.
|
||||
|
||||
import sys, os
|
||||
from datetime import date
|
||||
|
||||
# If extensions (or modules to document with autodoc) are in another directory,
|
||||
# add these directories to sys.path here. If the directory is relative to the
|
||||
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
||||
#sys.path.insert(0, os.path.abspath('.'))
|
||||
|
||||
# -- General configuration -----------------------------------------------------
|
||||
|
||||
# If your documentation needs a minimal Sphinx version, state it here.
|
||||
#needs_sphinx = '1.0'
|
||||
|
||||
# Add any Sphinx extension module names here, as strings. They can be extensions
|
||||
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
||||
extensions = ['sphinx.ext.todo', 'sphinx.ext.mathjax', 'sphinx.ext.intersphinx']
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = ['_templates']
|
||||
|
||||
# The suffix of source filenames.
|
||||
source_suffix = '.rst'
|
||||
|
||||
# The encoding of source files.
|
||||
#source_encoding = 'utf-8-sig'
|
||||
|
||||
# The master toctree document.
|
||||
master_doc = 'ReleaseNotes'
|
||||
|
||||
# General information about the project.
|
||||
project = u'Flang'
|
||||
copyright = u'2017-%d, The Flang Team' % date.today().year
|
||||
|
||||
# The version info for the project you're documenting, acts as replacement for
|
||||
# |version| and |release|, also used in various other places throughout the
|
||||
# built documents. These are currently set to zero because we don't use them.
|
||||
# Should somebody consider in the future to change them, they need to be updated
|
||||
# everytime a new release comes out.
|
||||
#
|
||||
# The short version.
|
||||
#version = '0'
|
||||
# The full version, including alpha/beta/rc tags.
|
||||
#release = '0'
|
||||
|
||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||
# for a list of supported languages.
|
||||
#language = None
|
||||
|
||||
# There are two options for replacing |today|: either, you set today to some
|
||||
# non-false value, then it is used:
|
||||
#today = ''
|
||||
# Else, today_fmt is used as the format for a strftime call.
|
||||
#today_fmt = '%B %d, %Y'
|
||||
|
||||
# List of patterns, relative to source directory, that match files and
|
||||
# directories to ignore when looking for source files.
|
||||
exclude_patterns = ['_build', 'analyzer']
|
||||
|
||||
# The reST default role (used for this markup: `text`) to use for all documents.
|
||||
#default_role = None
|
||||
|
||||
# If true, '()' will be appended to :func: etc. cross-reference text.
|
||||
#add_function_parentheses = True
|
||||
|
||||
# If true, the current module name will be prepended to all description
|
||||
# unit titles (such as .. function::).
|
||||
#add_module_names = True
|
||||
|
||||
# If true, sectionauthor and moduleauthor directives will be shown in the
|
||||
# output. They are ignored by default.
|
||||
#show_authors = False
|
||||
|
||||
# The name of the Pygments (syntax highlighting) style to use.
|
||||
pygments_style = 'friendly'
|
||||
|
||||
# A list of ignored prefixes for module index sorting.
|
||||
#modindex_common_prefix = []
|
||||
|
||||
|
||||
# -- Options for HTML output ---------------------------------------------------
|
||||
|
||||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||
# a list of builtin themes.
|
||||
html_theme = 'llvm-theme'
|
||||
|
||||
# Theme options are theme-specific and customize the look and feel of a theme
|
||||
# further. For a list of options available for each theme, see the
|
||||
# documentation.
|
||||
html_theme_options = { "nosidebar": False }
|
||||
|
||||
# Add any paths that contain custom themes here, relative to this directory.
|
||||
html_theme_path = ["_themes"]
|
||||
|
||||
# Add any paths that contain custom themes here, relative to this directory.
|
||||
#html_theme_path = []
|
||||
|
||||
# The name for this set of Sphinx documents. If None, it defaults to
|
||||
# "<project> v<release> documentation".
|
||||
html_title = 'The Flang Compiler'
|
||||
|
||||
# A shorter title for the navigation bar. Default is the same as html_title.
|
||||
#html_short_title = None
|
||||
|
||||
# The name of an image file (relative to this directory) to place at the top
|
||||
# of the sidebar.
|
||||
#html_logo = None
|
||||
|
||||
# The name of an image file (within the static path) to use as favicon of the
|
||||
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
||||
# pixels large.
|
||||
#html_favicon = None
|
||||
|
||||
# Add any paths that contain custom static files (such as style sheets) here,
|
||||
# relative to this directory. They are copied after the builtin static files,
|
||||
# so a file named "default.css" will overwrite the builtin "default.css".
|
||||
html_static_path = ['_static']
|
||||
|
||||
html_context = {
|
||||
'css_files': [
|
||||
'_static/llvm.css'
|
||||
],
|
||||
}
|
||||
|
||||
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
||||
# using the given strftime format.
|
||||
html_last_updated_fmt = '%b %d, %Y'
|
||||
|
||||
# If true, SmartyPants will be used to convert quotes and dashes to
|
||||
# typographically correct entities.
|
||||
#html_use_smartypants = True
|
||||
|
||||
# Custom sidebar templates, maps document names to template names.
|
||||
#html_sidebars = {}
|
||||
|
||||
# Additional templates that should be rendered to pages, maps page names to
|
||||
# template names.
|
||||
#html_additional_pages = {}
|
||||
|
||||
# If false, no module index is generated.
|
||||
#html_domain_indices = True
|
||||
|
||||
# If false, no index is generated.
|
||||
#html_use_index = True
|
||||
|
||||
# If true, the index is split into individual pages for each letter.
|
||||
#html_split_index = False
|
||||
|
||||
# If true, links to the reST sources are added to the pages.
|
||||
#html_show_sourcelink = True
|
||||
|
||||
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
|
||||
#html_show_sphinx = True
|
||||
|
||||
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
|
||||
#html_show_copyright = True
|
||||
|
||||
# If true, an OpenSearch description file will be output, and all pages will
|
||||
# contain a <link> tag referring to it. The value of this option must be the
|
||||
# base URL from which the finished HTML is served.
|
||||
#html_use_opensearch = ''
|
||||
|
||||
# This is the file name suffix for HTML files (e.g. ".xhtml").
|
||||
#html_file_suffix = None
|
||||
|
||||
# Output file base name for HTML help builder.
|
||||
htmlhelp_basename = 'Flangdoc'
|
||||
|
||||
# If true, the reST sources are included in the HTML build as
|
||||
# _sources/name. The default is True.
|
||||
html_copy_source = False
|
||||
|
||||
# -- Options for LaTeX output --------------------------------------------------
|
||||
|
||||
latex_elements = {
|
||||
# The paper size ('letterpaper' or 'a4paper').
|
||||
#'papersize': 'letterpaper',
|
||||
|
||||
# The font size ('10pt', '11pt' or '12pt').
|
||||
#'pointsize': '10pt',
|
||||
|
||||
# Additional stuff for the LaTeX preamble.
|
||||
#'preamble': '',
|
||||
}
|
||||
|
||||
# Grouping the document tree into LaTeX files. List of tuples
|
||||
# (source start file, target name, title, author, documentclass [howto/manual]).
|
||||
latex_documents = [
|
||||
('ReleaseNotes', 'Flang.tex', u'Flang Documentation',
|
||||
u'The Flang Team', 'manual'),
|
||||
]
|
||||
|
||||
# The name of an image file (relative to this directory) to place at the top of
|
||||
# the title page.
|
||||
#latex_logo = None
|
||||
|
||||
# For "manual" documents, if this is true, then toplevel headings are parts,
|
||||
# not chapters.
|
||||
#latex_use_parts = False
|
||||
|
||||
# If true, show page references after internal links.
|
||||
#latex_show_pagerefs = False
|
||||
|
||||
# If true, show URL addresses after external links.
|
||||
#latex_show_urls = False
|
||||
|
||||
# Documents to append as an appendix to all manuals.
|
||||
#latex_appendices = []
|
||||
|
||||
# If false, no module index is generated.
|
||||
#latex_domain_indices = True
|
||||
|
||||
|
||||
# -- Options for manual page output --------------------------------------------
|
||||
|
||||
# One entry per manual page. List of tuples
|
||||
# (source start file, name, description, authors, manual section).
|
||||
man_pages = []
|
||||
|
||||
# If true, show URL addresses after external links.
|
||||
#man_show_urls = False
|
||||
|
||||
|
||||
# -- Options for Texinfo output ------------------------------------------------
|
||||
|
||||
# Grouping the document tree into Texinfo files. List of tuples
|
||||
# (source start file, target name, title, author,
|
||||
# dir menu entry, description, category)
|
||||
texinfo_documents = [
|
||||
('ReleaseNotes', 'Flang', u'Flang Documentation',
|
||||
u'The Flang Team', 'Flang', 'One line description of project.',
|
||||
'Miscellaneous'),
|
||||
]
|
||||
|
||||
# Documents to append as an appendix to all manuals.
|
||||
#texinfo_appendices = []
|
||||
|
||||
# If false, no module index is generated.
|
||||
#texinfo_domain_indices = True
|
||||
|
||||
# How to display URL addresses: 'footnote', 'no', or 'inline'.
|
||||
#texinfo_show_urls = 'footnote'
|
||||
Reference in New Issue
Block a user