Skip to content

Commit

Permalink
wip
Browse files Browse the repository at this point in the history
  • Loading branch information
tkknight committed Nov 9, 2023
1 parent 1fe628d commit d744432
Show file tree
Hide file tree
Showing 3 changed files with 176 additions and 194 deletions.
17 changes: 0 additions & 17 deletions docs/src/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,6 @@ def _dotv(version):
"sphinx.ext.intersphinx",
"sphinx_copybutton",
"sphinx.ext.napoleon",
"numpydoc",
"sphinx_design",
"sphinx_gallery.gen_gallery",
"matplotlib.sphinxext.mathmpl",
Expand All @@ -169,22 +168,6 @@ def _dotv(version):
extensions.extend(["sphinxcontrib.apidoc"])
extensions.extend(["api_rst_formatting"])

# -- Numpydoc -----------------------------------------------------------------
# See https://numpydoc.readthedocs.io/en/latest/install.html#configuration
# TREMTEST
# numpydoc_use_plots = True # ?
numpydoc_show_class_members = False # False stops lots of warnings: https://stackoverflow.com/questions/65198998/sphinx-warning-autosummary-stub-file-not-found-for-the-methods-of-the-class-c
# numpydoc_show_inherited_class_members
# numpydoc_class_members_toctree
# numpydoc_citation_re
# numpydoc_attributes_as_param_list
numpydoc_xref_param_type = True # add hyperlink to types
# numpydoc_xref_aliases
# numpydoc_xref_ignore
# numpydoc_validation_checks
# numpydoc_validation_exclude


# -- Napoleon extension -------------------------------------------------------
# See https://sphinxcontrib-napoleon.readthedocs.io/en/latest/sphinxcontrib.napoleon.html
napoleon_google_docstring = True
Expand Down
6 changes: 2 additions & 4 deletions lib/iris/fileformats/netcdf/loader.py
Original file line number Diff line number Diff line change
Expand Up @@ -500,9 +500,7 @@ def load_cubes(file_sources, callback=None, constraints=None):
One or more NetCDF filenames/OPeNDAP URLs to load from.
OR open datasets.
Kwargs:
* callback (callable function):
callback: function, optional
Function which can be passed on to :func:`iris.io.run_callback`.
Returns
Expand All @@ -511,7 +509,7 @@ def load_cubes(file_sources, callback=None, constraints=None):
"""
# TODO: rationalise UGRID/mesh handling once experimental.ugrid is folded
# into standard behaviour.
# into standard behaviour.
# Deferred import to avoid circular imports.
from iris.experimental.ugrid.cf import CFUGridReader
from iris.experimental.ugrid.load import (
Expand Down
Loading

0 comments on commit d744432

Please sign in to comment.