Skip to content

Commit

Permalink
Removed unwanted code. Updated attribute hash colon to triple quotes
Browse files Browse the repository at this point in the history
  • Loading branch information
tkknight committed Jul 30, 2024
1 parent 4d1ed6d commit be1bb2a
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 28 deletions.
32 changes: 5 additions & 27 deletions docs/src/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ def autolog(message: str, section: str | None = None, color: str | None = None)

# -- Path setup --------------------------------------------------------------

# If extensions (or modules to document with autodoc) are in another directory,
# If extensions (or modules to document with api) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.

Expand Down Expand Up @@ -220,40 +220,18 @@ def _dotv(version):
# See https://www.sphinx-doc.org/en/master/usage/extensions/todo.html
todo_include_todos = True

# # https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#confval-autodoc_typehints
# -- autodoc options ---------------------------------------------------------
# See https://sphinx-autoapi.readthedocs.io/en/latest/how_to.html#how-to-include-type-annotations-as-types-in-rendered-docstrings
# https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html
autodoc_typehints = "description"
# autosummary_generate = True
# autosummary_imported_members = True
# autopackage_name = ["iris"]
# autoclass_content = "both"
# modindex_common_prefix = ["iris"]
autodoc_typehints_description_target = "documented"

# -- autoapi extensions -------------------------------------------------------
# See https://sphinx-autoapi.readthedocs.io/en/latest/reference/config.html
# https://github.com/readthedocs/sphinx-autoapi
todo_include_todos = False
todo_emit_warnings = False

# sphinx.ext.autodoc configuration --------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#confval-autodoc_default_options
autodoc_default_options = {
"members": True,
"member-order": "alphabetical",
"undoc-members": True,
"private-members": False,
"special-members": False,
"inherited-members": True,
"show-inheritance": True,
}

# https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#confval-autodoc_typehints
autodoc_typehints = "none"
autosummary_generate = True
autosummary_imported_members = True
autopackage_name = ["iris"]
autoclass_content = "both"
modindex_common_prefix = ["iris"]

# -- apidoc extension ---------------------------------------------------------
# See https://github.com/sphinx-contrib/apidoc

Expand Down
3 changes: 2 additions & 1 deletion lib/iris/experimental/ugrid.py
Original file line number Diff line number Diff line change
Expand Up @@ -132,8 +132,9 @@ def context(self):
yield


#: Run-time switch for experimental UGRID-aware NetCDF loading. See :class:`~iris.mesh.load.ParseUGridOnLoad`.
PARSE_UGRID_ON_LOAD = ParseUGridOnLoad()
"""Run-time switch for experimental UGRID-aware NetCDF loading.
See :class:`~iris.mesh.load.ParseUGridOnLoad`."""


__all__ = [
Expand Down

0 comments on commit be1bb2a

Please sign in to comment.