Skip to content
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.

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

Iris Docs: Dark theme ready #5299

Merged
merged 8 commits into from
May 24, 2023
Merged
Show file tree
Hide file tree
Changes from 7 commits
Commits
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
63 changes: 37 additions & 26 deletions docs/src/_static/icon_api.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/src/_static/theme_override.css
trexfeathers marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/* import the standard theme css */
@import url("css/theme.css");
@import url("styles/theme.css");

/* now we can add custom css.... */

Expand Down
13 changes: 7 additions & 6 deletions docs/src/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -317,9 +317,9 @@ def _dotv(version):
],
"use_edit_page_button": True,
"show_toc_level": 1,
# Omitted `theme-switcher` below to disable it
# Omit `theme-switcher` from navbar_end below to disable it
# Info: https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/light-dark.html#configure-default-theme-mode
"navbar_end": ["navbar-icon-links"],
# "navbar_end": ["navbar-icon-links"],
# https://pydata-sphinx-theme.readthedocs.io/en/v0.11.0/user_guide/branding.html#different-logos-for-light-and-dark-mode
"logo": {
"image_light": "_static/iris-logo-title.svg",
Expand All @@ -338,7 +338,7 @@ def _dotv(version):
"doc_path": "docs/src",
# default theme. Also disabled the button in the html_theme_options.
# Info: https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/light-dark.html#configure-default-theme-mode
"default_mode": "light",
"default_mode": "auto",
# custom
"on_rtd": on_rtd,
"rtd_version": rtd_version,
Expand All @@ -355,13 +355,14 @@ def _dotv(version):
html_static_path = ["_static"]
html_style = "theme_override.css"

# this allows for using datatables: https://datatables.net/
# this allows for using datatables: https://datatables.net/.
# the version can be manually upgraded by changing the urls below.
html_css_files = [
"https://cdn.datatables.net/1.10.23/css/jquery.dataTables.min.css",
"https://cdn.datatables.net/1.13.4/css/jquery.dataTables.min.css",
]

html_js_files = [
"https://cdn.datatables.net/1.10.23/js/jquery.dataTables.min.js",
"https://cdn.datatables.net/1.13.4/js/jquery.dataTables.min.js",
]

# url link checker. Some links work but report as broken, lets ignore them.
Expand Down
1,375 changes: 1,374 additions & 1 deletion docs/src/further_topics/ugrid/images/data_structured_grid.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2,274 changes: 2,273 additions & 1 deletion docs/src/further_topics/ugrid/images/data_ugrid_mesh.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
32 changes: 16 additions & 16 deletions docs/src/further_topics/ugrid/images/iris-esmf-regrid.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/src/further_topics/ugrid/images/orca_grid.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
631 changes: 630 additions & 1 deletion docs/src/further_topics/ugrid/images/ugrid_edge_data.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1,277 changes: 1,276 additions & 1 deletion docs/src/further_topics/ugrid/images/ugrid_element_centres.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
866 changes: 865 additions & 1 deletion docs/src/further_topics/ugrid/images/ugrid_node_independence.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
944 changes: 943 additions & 1 deletion docs/src/further_topics/ugrid/images/ugrid_variable_faces.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
52 changes: 26 additions & 26 deletions docs/src/further_topics/ugrid/operations.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,8 @@ structured formats and non-UGRID mesh formats.
The objects created in this example will be used where possible in the
subsequent example operations on this page.

.. dropdown:: :octicon:`code`
:color: light
.. dropdown:: Code
:icon: code

.. doctest:: ugrid_operations

Expand Down Expand Up @@ -146,8 +146,8 @@ Creating a :class:`~iris.cube.Cube` is unchanged; the
:class:`~iris.experimental.ugrid.Mesh` is linked via a
:class:`~iris.experimental.ugrid.MeshCoord` (see :ref:`ugrid MeshCoords`):

.. dropdown:: :octicon:`code`
:color: light
.. dropdown:: Code
:icon: code

.. doctest:: ugrid_operations

Expand Down Expand Up @@ -208,8 +208,8 @@ The Iris saving process automatically detects if the :class:`~iris.cube.Cube`
has an associated :class:`~iris.experimental.ugrid.Mesh` and automatically
saves the file in a UGRID-conformant format:

.. dropdown:: :octicon:`code`
:color: light
.. dropdown:: Code
:icon: code

.. doctest:: ugrid_operations

Expand Down Expand Up @@ -284,8 +284,8 @@ The :func:`iris.experimental.ugrid.save_mesh` function allows
:class:`~iris.experimental.ugrid.Mesh`\es to be saved to file without
associated :class:`~iris.cube.Cube`\s:

.. dropdown:: :octicon:`code`
:color: light
.. dropdown:: Code
:icon: code

.. doctest:: ugrid_operations

Expand Down Expand Up @@ -356,8 +356,8 @@ loading a file remains **optional**. To load UGRID data from a file into the
Iris mesh data model, use the
:const:`iris.experimental.ugrid.PARSE_UGRID_ON_LOAD` context manager:

.. dropdown:: :octicon:`code`
:color: light
.. dropdown:: Code
:icon: code

.. doctest:: ugrid_operations

Expand All @@ -377,8 +377,8 @@ All the existing loading functionality still operates on UGRID-compliant
data - :class:`~iris.Constraint`\s, callbacks, :func:`~iris.load_cube`
etcetera:

.. dropdown:: :octicon:`code`
:color: light
.. dropdown:: Code
:icon: code

.. doctest:: ugrid_operations

Expand Down Expand Up @@ -421,8 +421,8 @@ The :func:`iris.experimental.ugrid.load_mesh` and
:class:`~iris.experimental.ugrid.Mesh`\es to be loaded from a file without
creating any associated :class:`~iris.cube.Cube`\s:

.. dropdown:: :octicon:`code`
:color: light
.. dropdown:: Code
:icon: code

.. doctest:: ugrid_operations

Expand Down Expand Up @@ -476,8 +476,8 @@ be added to API in the near future.
This first example uses GeoVista to plot the ``face_cube`` that we created
earlier:

.. dropdown:: :octicon:`code`
:color: light
.. dropdown:: Code
:icon: code

.. code-block:: python

Expand Down Expand Up @@ -547,8 +547,8 @@ earlier:

Here's another example using a global cubed-sphere data set:

.. dropdown:: :octicon:`code`
:color: light
.. dropdown:: Code
:icon: code

.. code-block:: python

Expand Down Expand Up @@ -623,8 +623,8 @@ therefore set to return an :class:`~iris.coords.AuxCoord` instead - breaking
the link between :class:`~iris.cube.Cube` and
:class:`~iris.experimental.ugrid.Mesh`:

.. dropdown:: :octicon:`code`
:color: light
.. dropdown:: Code
:icon: code

.. doctest:: ugrid_operations

Expand Down Expand Up @@ -667,8 +667,8 @@ mesh, we then reconstruct a :class:`~iris.experimental.ugrid.Mesh` from the
..
Not using doctest here as want to keep GeoVista as optional dependency.

.. dropdown:: :octicon:`code`
:color: light
.. dropdown:: Code
:icon: code

.. code-block:: python

Expand Down Expand Up @@ -795,8 +795,8 @@ with the
..
Not using doctest here as want to keep iris-esmf-regrid as optional dependency.

.. dropdown:: :octicon:`code`
:color: light
.. dropdown:: Code
:icon: code

.. code-block:: python

Expand Down Expand Up @@ -892,8 +892,8 @@ Since calling a regridder is usually a lot faster than initialising, reusing
regridders can save a lot of time. We can demonstrate the reuse of the
previously initialised regridder:

.. dropdown:: :octicon:`code`
:color: light
.. dropdown:: Code
:icon: code

.. code-block:: python

Expand Down
Loading