Skip to content

Updated the branding and execution of Iris docs #3050

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
DPeterK merged 4 commits into from
Jun 7, 2018
Merged

Updated the branding and execution of Iris docs #3050

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d01c4da
Updated the branding and execution of Iris
pelson Jun 6, 2018
2b441af
Added a favicon for the docs.
pelson Jun 7, 2018
2cbe177
Improve strapline style, content (#27)
DPeterK Jun 7, 2018
fc66207
Further improvements to Iris docs
pelson Jun 7, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
</h1>

<h4 align="center">
Iris is a powerful, easy to use, and community-driven Python library for
Iris is a powerful, format-agnostic, and community-driven Python library for

@DPeterK DPeterK Jun 7, 2018 •
edited
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are you saying it isn't?? 😉

Actually though, I've long thought that this introductory statement was a bit full of itself, and this change helps. Note that this comment is duplicated in the description at the top of the Iris repo on GitHub too, so we should make the equivalent change there too.

@pelson pelson Jun 7, 2018

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep. Will do now that it is reviewed 👍

analysing and visualising Earth science data
</h4>

Expand Down
Binary file added docs/iris/src/_static/favicon-16x16.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/iris/src/_static/favicon-32x32.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
60 changes: 59 additions & 1 deletion docs/iris/src/_static/style.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,62 @@ p.hr_p:after {
left: 0.5em;
margin-right: -50%;
}


.header-content {
background-color: white;
text-align: left;
padding: 0px;
height: 149px;
}

.header-content img {
height: 100px;
vertical-align: middle;
float: left;
margin: 20px 2em 0.8em 4%;
padding: 0px;
}

.header-content .strapline {
display: inline-block;
width: calc(100% - 110px - 2em - 4%);
}

.header-content h1 {
font-size: 3.5rem;
font-family: 'Alike', serif;
margin-top: 40px;
padding: 0px;
color: #323232;
padding-bottom: 0.2em;
}

.header-content h1 span.version {
font-size: 1.5rem;
}

.header-content h2 {
padding: 0px; max-width: 60ch; margin-top: 0px; margin-bottom: 0px;
}

.github-forkme {
position: absolute;
top: 0;
right: 80px;
border: 0;
}

/* Take into account the resizing effect of the page (which has a minimum */
/* width of 740px + 80px margins). */
@media screen and (max-width: calc(740px + 80px + 80px)) {
.github-forkme {
right: calc(100% - 740px - 80px);
}
}

@media screen and (max-width: calc(740px + 80px)) {
.github-forkme {
left: calc(740px + 80px - 149px);
right: 0px;
}
}
11 changes: 1 addition & 10 deletions docs/iris/src/_templates/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
{{ super() }}

<script type="text/javascript" src="{{ pathto("_static/jquery.cycle.all.latest.js", 1) }}"></script>
<script type="text/javascript" src="{{ pathto("_static/random_image.js", 1) }}"></script>
<script type="text/javascript" src="{{ pathto("_static/random_image.js", 1) }}" async></script>

<style type="text/css">
#slideshow { width: 400px; }
Expand All @@ -13,15 +13,6 @@
#sliderNav div { display: inline-block; height: 8px; width: 8px; margin: 0 2px;
border: #ccc medium solid; border-radius: 50%; box-shadow: 0 0 2px 0 #ccc;}
#sliderNav div.activeSlide { border-color: #777; background-color: #ccc; }


.bodywrapper {

@pelson pelson Jun 6, 2018

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was removed, as I added it to hide the search bar. I think that is premature for the release.
Long-term, I'd like to move the search to the nav bar at the top.

width: 100%;
}
.sphinxsidebarwrapper {
display: none
}

</style>

<script type="text/javascript">
Expand Down
53 changes: 15 additions & 38 deletions docs/iris/src/_templates/layout.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@
<link rel="stylesheet" href="{{ pathto('_static/style.css', 1) }}" type="text/css" />
<script type="text/javascript" src="http://docs.python.org/2/_static/copybutton.js"></script>

<!-- Nice fonts... -->
<link rel="icon" type="image/png" sizes="32x32" href="{{ pathto('_static/favicon-32x32.png', 1) }}">
<link rel="icon" type="image/png" sizes="16x16" href="{{ pathto('_static/favicon-16x16.png', 1) }}">

<link href="https://fonts.googleapis.com/css?family=Alike" rel="stylesheet">
{% endblock %}

Expand All @@ -23,49 +25,24 @@

{% block relbar1 %}




<style>
.github-img {

@pelson pelson Jun 6, 2018

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These were moved into style.css.

@DPeterK DPeterK Jun 7, 2018

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@pelson given our recent conversation I am very pleased to see this moved!

position: absolute;
top: 0;
right: 80px;
border: 0;
}

/* Take into account the resizing effect of the page (which has a minimum */
/* width of 740px + 80px margins). */
@media screen and (max-width: calc(740px + 80px + 80px)) {
.github-img {
right: calc(100% - 740px - 80px);
}
}

@media screen and (max-width: calc(740px + 80px)) {
.github-img {
left: calc(740px + 80px - 149px);
right: 0px;
}
}
</style>
<a href="https://github.com/you">
<img class="github-img" src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub">
<a href="https://github.com/SciTools/iris">
<img class="github-forkme" src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png"
alt="Fork Iris on GitHub" />
</a>


<div style="background-color: white; text-align: left; padding: 0px; height: 149px;">
<div class="header-content">
<a href="{{ pathto("index") }}">
<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" />
<img src="{{ pathto("_static/Iris7_1_trim_100.png", 1) }}" alt="Iris logo" />
</a>
<div style="display: inline-block; width: calc(100% - 110px - 2em - 4%);">
<h1 style="font-size: 3.5rem; font-family: 'Alike', serif; margin-top: 40px; padding: 0px; color: #323232; padding-bottom: 0.2em;">
Iris <span style="font-size: 1.5rem;">v2.1</span>
<div class="strapline">
<h1>
Iris <span class="version">v2.1</span>
</h1>
<h4 style="padding: 0px; max-width: 60ch; margin-top: 0px; margin-bottom: 0px;">
a powerful, easy to use, community-driven Python library for analysing and
<h2>

@DPeterK DPeterK Jun 7, 2018

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@pelson I think we could format this a little differently and make it more shiny ✨ PR incoming, as per your request...

a powerful, format-agnostic, and community-driven Python library for analysing and

@DPeterK DPeterK Jun 7, 2018

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could this be a proper sentence? That is, start with a capital letter and end with a full stop. I think it might look a little more professional if it were.

@kaedonkers kaedonkers Jun 7, 2018

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I second this!

visualising Earth science data
</h4>
</h2>
</div>
</div>

Expand All @@ -90,5 +67,5 @@ <h4 style="padding: 0px; max-width: 60ch; margin-top: 0px; margin-bottom: 0px;">
</div>

<!-- Include a version switcher to easily move between the documentation of different versions -->
<script type=text/javascript src=/iris/docs/version_switch.js></script>
<script type=text/javascript src="/iris/docs/version_switch.js" async></script>
{% endblock %}
15 changes: 12 additions & 3 deletions docs/iris/src/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,12 +56,13 @@
# 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.autodoc',
'sphinx.ext.coverage',
'sphinx.ext.imgmath',
'sphinx.ext.autosummary',
'sphinx.ext.coverage',
'sphinx.ext.doctest',
'sphinx.ext.extlinks',
'sphinx.ext.graphviz',
'sphinx.ext.imgmath',
'sphinx.ext.intersphinx',
'sphinx.ext.doctest',
'matplotlib.sphinxext.mathmpl',
'matplotlib.sphinxext.only_directives',
'matplotlib.sphinxext.plot_directive',
Expand Down Expand Up @@ -163,6 +164,14 @@
'scipy': ('http://docs.scipy.org/doc/scipy/reference/', None),
}

# -- Extlinks extension -------------------------------------------------------

extlinks = {'issues': ('https://github.com/SciTools/iris/labels/%s',

@DPeterK DPeterK Jun 7, 2018

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could consider renaming this key to 'label'?

'issues labeled with '),
'issue': ('https://github.com/SciTools/iris/issues/%s',
'Issue #'),
'pull': ('https://github.com/SciTools/iris/pull/%s', 'PR #'),
}

# -- Doctest ------------------------------------------------------------------

Expand Down
11 changes: 6 additions & 5 deletions docs/iris/src/whatsnew/2.1.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,23 +53,24 @@ Iris 2.1 Features
* Added :meth:`iris.analysis.trajectory.interpolate` that allows you to
interpolate to find values along a trajectory.
* It is now possible to add an attribute of ``missing_value`` to a cube.
https://github.com/SciTools/iris/issues/1588
(:issue:`1588`)
* Iris can now represent data on the Albers Equal Area Projection,
and the NetCDF loader and saver were updated to handle this.
https://github.com/SciTools/iris/issues/2943
and the NetCDF loader and saver were updated to handle this. (:issue:`2943`)
* The :class:`~iris.coord_systems.Mercator` projection has been updated to accept
the ``standard_parallel`` keyword argument.
the ``standard_parallel`` keyword argument. (:pr:`3041`)

@DPeterK DPeterK Jun 7, 2018

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This sphinx admonition isn't rendering properly in the build – think it needs to be (:pull:`3041`) instead.


Bugs Fixed
==========

* All var names being written to NetCDF are now CF compliant.
Non alpha-numeric characters are replaced with '_', and var names now always
have a leading letter. https://github.com/SciTools/iris/pull/2930
have a leading letter. (:pull:`2930`)

@DPeterK DPeterK Jun 7, 2018

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's a stylistic thing only but I'd prefer to see the brackets containing the link inside the sentence; something like:

* :mod:`iris.quickplot` labels now honour the axes being drawn to when using the ``axes`` keyword (:pull:`3010`).

(I've chosen a shorter example from below for the sake of brevity.)

* A cube resulting from a regrid operation using the `iris.analysis.AreaWeighted`
regridding scheme will now have the smallest floating point data type
to which the source cube's data type can be safely converted using NumPy's
type promotion rules.
* :mod:`iris.quickplot` labels now honour the axes being drawn to when using the
``axes=`` keyword. (:pull:`3010`)

@DPeterK DPeterK Jun 7, 2018

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we drop the = from the preformatted text on this line? Having it feels a little tautological...


Incompatible Changes
====================
Expand Down
2 changes: 1 addition & 1 deletion setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -239,7 +239,7 @@ def extract_version():
url='http://scitools.org.uk/iris/',
author='UK Met Office',
author_email='scitools-iris-dev@googlegroups.com',
description="A powerful, easy to use, and community-driven Python "
description="A powerful, format-agnostic, and community-driven Python "
"library for analysing and visualising Earth science data",
long_description=description,
long_description_content_type='text/markdown',
Expand Down