Skip to content

Commit 30e818d

Browse files
jdoerfertjdoerfert
committed
[OpenMP][Docs] Structure and content for the OpenMP documentation
This adds some initial content as well as structure to the new OpenMP Sphinx documentation hosted at http://openmp.llvm.org/docs/ . The content contains some useful links but most pages are still empty. This uses a "custom" theme which is a copy of the default "agogo" one with minor modifications to get a nicer table of content in the sidebar. This way we can also adjust the theme as we go. Reviewed By: jhuber6, JonChesterfield Differential Revision: https://reviews.llvm.org/D90256
1 parent 2c58fa5 commit 30e818d

File tree

18 files changed

+855
-45
lines changed

18 files changed

+855
-45
lines changed

‎openmp/docs/ReleaseNotes.rst‎

Lines changed: 4 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,23 @@
11
===========================
2-
OpenMP 11.0.0 Release Notes
2+
OpenMP 12.0.0 Release Notes
33
===========================
44

5-
.. contents::
6-
:local:
75

86
.. warning::
9-
These are in-progress notes for the upcoming LLVM 11.0.0 release.
7+
These are in-progress notes for the upcoming LLVM 12.0.0 release.
108
Release notes for previous releases can be found on
119
`the Download Page <https://releases.llvm.org/download.html>`_.
10+
1211

1312
Introduction
1413
============
1514

16-
This document contains the release notes for the OpenMP runtime, release 11.0.0.
15+
This document contains the release notes for the OpenMP runtime, release 12.0.0.
1716
Here we describe the status of openmp, including major improvements
1817
from the previous release. All openmp releases may be downloaded
1918
from the `LLVM releases web site <https://llvm.org/releases/>`_.
2019

2120
Non-comprehensive list of changes in this release
2221
=================================================
2322

24-
5.0 features
25-
------------
26-
27-
* ...
28-
29-
5.1 features
30-
------------
31-
32-
* ...
33-
34-
OMPT Improvements
35-
-----------------
36-
37-
* Added OMPT callbacks for doacross loops, detached tasks
38-
* Added handling for mutexinoutset dependencies
39-
40-
OMPT-based Tools
41-
----------------
42-
43-
* Added ompt-multiplex.h as a header-only OMPT-tool to support nesting of OMPT
44-
tools. (see openmp/tools/multiplex)
4523

‎openmp/docs/SupportAndFAQ.rst‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Support And FAQ
2+
===============
3+
4+

‎openmp/docs/_themes/llvm-openmp-theme/layout.html‎

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
{#
2+
llvm-openmp-theme/layout.html
3+
~~~~~~~~~~~~~~~~~
4+
5+
Sphinx layout template for LLVM/OpenMP which as an almost identical clone
6+
of the agogo theme, originally written by Andi Albrecht.
7+
8+
:copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
9+
:license: BSD, see LICENSE for details.
10+
#}
11+
{%- extends "basic/layout.html" %}
12+
13+
{% block header %}
14+
<div class="header-wrapper" role="banner">
15+
<div class="header">
16+
{%- if logo %}
17+
<p class="logo"><a href="{{ pathto(master_doc)|e }}">
18+
<img class="logo" src="{{ pathto('_static/' + logo, 1)|e }}" alt="Logo"/>
19+
</a></p>
20+
{%- endif %}
21+
{%- block headertitle %}
22+
<div class="headertitle"><a
23+
href="{{ pathto(master_doc)|e }}">{{ shorttitle|e }}</a></div>
24+
{%- endblock %}
25+
<div class="rel" role="navigation" aria-label="related navigation">
26+
<a href="{{ pathto('index') }}" title="LLVM OpenMP Documentation">HOME</a>
27+
{{ reldelim2 }}
28+
{%- for rellink in rellinks|reverse %}
29+
<a href="{{ pathto(rellink[0])|e }}" title="{{ rellink[1]|striptags|e }}"
30+
{{ accesskey(rellink[2]) }}>{{ rellink[3] }}</a>
31+
{%- if not loop.last %}{{ reldelim2 }}{% endif %}
32+
{%- endfor %}
33+
</div>
34+
</div>
35+
</div>
36+
{% endblock %}
37+
38+
39+
{%- macro llvm_openmp_sidebar() %}
40+
{%- block sidebartoc %}
41+
<h3>{{ _('Table of Contents') }}</h3>
42+
{{ toctree(includehidden=True, titles_only=True, maxdepth=2) }}
43+
{%- endblock %}
44+
{%- block sidebarsearch %}
45+
<div role="search">
46+
<h3 style="margin-top: 1.5em;">{{ _('Search') }}</h3>
47+
<form class="search" action="{{ pathto('search') }}" method="get">
48+
<input type="text" name="q" />
49+
<input type="submit" value="{{ _('Go') }}" />
50+
</form>
51+
</div>
52+
{%- endblock %}
53+
{% endmacro %}
54+
55+
{% block content %}
56+
<div class="content-wrapper">
57+
<div class="content">
58+
{%- if not theme_rightsidebar|tobool %}
59+
<div class="sidebar">
60+
{{ llvm_openmp_sidebar() }}
61+
</div>
62+
{%- endif %}
63+
<div class="document">
64+
{%- block document %}
65+
{{ super() }}
66+
{%- endblock %}
67+
</div>
68+
{%- if theme_rightsidebar|tobool %}
69+
<div class="sidebar">
70+
{{ llvm_openmp_sidebar() }}
71+
</div>
72+
{%- endif %}
73+
<div class="clearer"></div>
74+
</div>
75+
</div>
76+
{% endblock %}
77+
78+
{% block footer %}
79+
<div class="footer-wrapper">
80+
<div class="footer">
81+
<div class="left">
82+
<div role="navigation" aria-label="related navigaton">
83+
<a href="{{ pathto('index') }}" title="LLVM OpenMP Documentation">HOME</a>
84+
{{ reldelim2 }}
85+
{%- for rellink in rellinks|reverse %}
86+
<a href="{{ pathto(rellink[0])|e }}" title="{{ rellink[1]|striptags|e }}"
87+
{{ accesskey(rellink[2]) }}>{{ rellink[3] }}</a>
88+
{%- if not loop.last %}{{ reldelim2 }}{% endif %}
89+
{%- endfor %}
90+
</div>
91+
<div role="note" aria-label="source link">
92+
{%- if show_source and has_source and sourcename %}
93+
<br/>
94+
<a href="{{ pathto('_sources/' + sourcename, true)|e }}"
95+
rel="nofollow">{{ _('Show Source') }}</a>
96+
{%- endif %}
97+
</div>
98+
</div>
99+
100+
<div class="right">
101+
{{ super() }}
102+
</div>
103+
<div class="clearer"></div>
104+
</div>
105+
</div>
106+
{% endblock %}
107+
108+
{% block relbar1 %}{% endblock %}
109+
{% block relbar2 %}{% endblock %}

0 commit comments

Comments
 (0)