Skip to content

Commit 9bd58bf

Browse files
pelsonpelson
committed
Updated the branding and execution of Iris
This includes: * removing the "easy-to-use" statement in Iris' strapline. Let's let users be the judge of that. * improved the styling of the homepage, including re-instating the search bar. * Added a what's new for #3010. * Added a extlinks section for convenient linking to github issues with :issue:`number` and :pr:`number`.
1 parent 5fa15f1 commit 9bd58bf

File tree

7 files changed

+90
-56
lines changed

7 files changed

+90
-56
lines changed

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
</h1>
66

77
<h4 align="center">
8-
Iris is a powerful, easy to use, and community-driven Python library for
8+
Iris is a powerful, format-agnostic, and community-driven Python library for
99
analysing and visualising Earth science data
1010
</h4>
1111

‎docs/iris/src/_static/style.css‎

Lines changed: 59 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,4 +29,62 @@ p.hr_p:after {
2929
left: 0.5em;
3030
margin-right: -50%;
3131
}
32-
32+
33+
.header-content {
34+
background-color: white;
35+
text-align: left;
36+
padding: 0px;
37+
height: 149px;
38+
}
39+
40+
.header-content img {
41+
height: 100px;
42+
vertical-align: middle;
43+
float: left;
44+
margin: 20px 2em 0.8em 4%;
45+
padding: 0px;
46+
}
47+
48+
.header-content .strapline {
49+
display: inline-block;
50+
width: calc(100% - 110px - 2em - 4%);
51+
}
52+
53+
.header-content h1 {
54+
font-size: 3.5rem;
55+
font-family: 'Alike', serif;
56+
margin-top: 40px;
57+
padding: 0px;
58+
color: #323232;
59+
padding-bottom: 0.2em;
60+
}
61+
62+
.header-content h1 span.version {
63+
font-size: 1.5rem;
64+
}
65+
66+
.header-content h2 {
67+
padding: 0px; max-width: 60ch; margin-top: 0px; margin-bottom: 0px;
68+
}
69+
70+
.github-forkme {
71+
position: absolute;
72+
top: 0;
73+
right: 80px;
74+
border: 0;
75+
}
76+
77+
/* Take into account the resizing effect of the page (which has a minimum */
78+
/* width of 740px + 80px margins). */
79+
@media screen and (max-width: calc(740px + 80px + 80px)) {
80+
.github-forkme {
81+
right: calc(100% - 740px - 80px);
82+
}
83+
}
84+
85+
@media screen and (max-width: calc(740px + 80px)) {
86+
.github-forkme {
87+
left: calc(740px + 80px - 149px);
88+
right: 0px;
89+
}
90+
}

‎docs/iris/src/_templates/index.html‎

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,6 @@
1313
#sliderNav div { display: inline-block; height: 8px; width: 8px; margin: 0 2px;
1414
border: #ccc medium solid; border-radius: 50%; box-shadow: 0 0 2px 0 #ccc;}
1515
#sliderNav div.activeSlide { border-color: #777; background-color: #ccc; }
16-
17-
18-
.bodywrapper {
19-
width: 100%;
20-
}
21-
.sphinxsidebarwrapper {
22-
display: none
23-
}
24-
2516
</style>
2617

2718
<script type="text/javascript">

‎docs/iris/src/_templates/layout.html‎

Lines changed: 11 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -23,49 +23,24 @@
2323

2424
{% block relbar1 %}
2525

26-
27-
28-
29-
<style>
30-
.github-img {
31-
position: absolute;
32-
top: 0;
33-
right: 80px;
34-
border: 0;
35-
}
36-
37-
/* Take into account the resizing effect of the page (which has a minimum */
38-
/* width of 740px + 80px margins). */
39-
@media screen and (max-width: calc(740px + 80px + 80px)) {
40-
.github-img {
41-
right: calc(100% - 740px - 80px);
42-
}
43-
}
44-
45-
@media screen and (max-width: calc(740px + 80px)) {
46-
.github-img {
47-
left: calc(740px + 80px - 149px);
48-
right: 0px;
49-
}
50-
}
51-
</style>
52-
<a href="https://github.com/you">
53-
<img class="github-img" src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub">
26+
<a href="https://github.com/SciTools/iris">
27+
<img class="github-forkme" src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png"
28+
alt="Fork Iris on GitHub" />
5429
</a>
5530

5631

57-
<div style="background-color: white; text-align: left; padding: 0px; height: 149px;">
32+
<div class="header-content">
5833
<a href="{{ pathto("index") }}">
59-
<img src="{{ pathto("_static/Iris7_1_trim_100.png", 1) }}" border="0" style="height: 100px; vertical-align: middle; float: left; margin: 20px 2em 0.8em 4%; padding: 0px;" alt="Logo" />
34+
<img src="{{ pathto("_static/Iris7_1_trim_100.png", 1) }}" alt="Iris logo" />
6035
</a>
61-
<div style="display: inline-block; width: calc(100% - 110px - 2em - 4%);">
62-
<h1 style="font-size: 3.5rem; font-family: 'Alike', serif; margin-top: 40px; padding: 0px; color: #323232; padding-bottom: 0.2em;">
63-
Iris <span style="font-size: 1.5rem;">v2.1</span>
36+
<div class="strapline">
37+
<h1>
38+
Iris <span class="version">v2.1</span>
6439
</h1>
65-
<h4 style="padding: 0px; max-width: 60ch; margin-top: 0px; margin-bottom: 0px;">
66-
a powerful, easy to use, community-driven Python library for analysing and
40+
<h2>
41+
a powerful, format-agnostic, and community-driven Python library for analysing and
6742
visualising Earth science data
68-
</h4>
43+
</h2>
6944
</div>
7045
</div>
7146

‎docs/iris/src/conf.py‎

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,12 +56,13 @@
5656
# Add any Sphinx extension module names here, as strings. They can be extensions
5757
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
5858
extensions = ['sphinx.ext.autodoc',
59-
'sphinx.ext.coverage',
60-
'sphinx.ext.imgmath',
6159
'sphinx.ext.autosummary',
60+
'sphinx.ext.coverage',
61+
'sphinx.ext.doctest',
62+
'sphinx.ext.extlinks',
6263
'sphinx.ext.graphviz',
64+
'sphinx.ext.imgmath',
6365
'sphinx.ext.intersphinx',
64-
'sphinx.ext.doctest',
6566
'matplotlib.sphinxext.mathmpl',
6667
'matplotlib.sphinxext.only_directives',
6768
'matplotlib.sphinxext.plot_directive',
@@ -163,6 +164,14 @@
163164
'scipy': ('http://docs.scipy.org/doc/scipy/reference/', None),
164165
}
165166

167+
# -- Extlinks extension -------------------------------------------------------
168+
169+
extlinks = {'issues': ('https://github.com/SciTools/iris/labels/%s',
170+
'issues labeled with '),
171+
'issue': ('https://github.com/SciTools/iris/issues/%s',
172+
'Issue #'),
173+
'pull': ('https://github.com/SciTools/iris/pull/%s', 'PR #'),
174+
}
166175

167176
# -- Doctest ------------------------------------------------------------------
168177

‎docs/iris/src/whatsnew/2.1.rst‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -53,23 +53,24 @@ Iris 2.1 Features
5353
* Added :meth:`iris.analysis.trajectory.interpolate` that allows you to
5454
interpolate to find values along a trajectory.
5555
* It is now possible to add an attribute of ``missing_value`` to a cube.
56-
https://github.com/SciTools/iris/issues/1588
56+
(:issue:`1588`)
5757
* Iris can now represent data on the Albers Equal Area Projection,
58-
and the NetCDF loader and saver were updated to handle this.
59-
https://github.com/SciTools/iris/issues/2943
58+
and the NetCDF loader and saver were updated to handle this. (:issue:`2943`)
6059
* The :class:`~iris.coord_systems.Mercator` projection has been updated to accept
61-
the ``standard_parallel`` keyword argument.
60+
the ``standard_parallel`` keyword argument. (:pr:`3041`)
6261

6362
Bugs Fixed
6463
==========
6564

6665
* All var names being written to NetCDF are now CF compliant.
6766
Non alpha-numeric characters are replaced with '_', and var names now always
68-
have a leading letter. https://github.com/SciTools/iris/pull/2930
67+
have a leading letter. (:pull:`2930`)
6968
* A cube resulting from a regrid operation using the `iris.analysis.AreaWeighted`
7069
regridding scheme will now have the smallest floating point data type
7170
to which the source cube's data type can be safely converted using NumPy's
7271
type promotion rules.
72+
* :mod:`iris.quickplot` labels now honour the axes being drawn to when using the
73+
``axes=`` keyword. (:pull:`3010`)
7374

7475
Incompatible Changes
7576
====================

‎setup.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -239,7 +239,7 @@ def extract_version():
239239
url='http://scitools.org.uk/iris/',
240240
author='UK Met Office',
241241
author_email='[email protected]',
242-
description="A powerful, easy to use, and community-driven Python "
242+
description="A powerful, format-agnostic, and community-driven Python "
243243
"library for analysing and visualising Earth science data",
244244
long_description=description,
245245
long_description_content_type='text/markdown',

0 commit comments

Comments
 (0)