From 0612ba05a7ebd18570ad2f69cf639a93955c721b Mon Sep 17 00:00:00 2001 From: "Sadie L. Bartholomew" Date: Thu, 16 Jul 2026 16:14:58 +0100 Subject: [PATCH 01/13] Add DomainList (copied FieldList) to API ref. class stub files --- docs/source/class/cf.DomainList.rst | 161 ++++++++++++++++++++++++++++ 1 file changed, 161 insertions(+) create mode 100644 docs/source/class/cf.DomainList.rst diff --git a/docs/source/class/cf.DomainList.rst b/docs/source/class/cf.DomainList.rst new file mode 100644 index 0000000000..410f782420 --- /dev/null +++ b/docs/source/class/cf.DomainList.rst @@ -0,0 +1,161 @@ +.. currentmodule:: cf +.. default-role:: obj + +.. _fieldlist: + +cf.DomainList +============= + +---- + +.. autoclass:: cf.DomainList + :no-members: + :no-inherited-members: + +Selecting +--------- + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.DomainList.select_by_construct + ~cf.DomainList.select_by_identity + ~cf.DomainList.select_by_naxes + ~cf.DomainList.select_by_ncvar + ~cf.DomainList.select_by_property + ~cf.DomainList.select_by_rank + ~cf.DomainList.select_by_units + ~cf.DomainList.select + ~cf.DomainList.select_field + ~cf.DomainList.__call__ + +Comparison +---------- + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.DomainList.equals + +.. _DomainList-xarray: + +xarray +------ + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.DomainList.to_xarray + +Miscellaneous +------------- + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.DomainList.close + ~cf.DomainList.concatenate + ~cf.DomainList.copy + +Aliases +------- + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.DomainList.select + ~cf.DomainList.__call__ + +List-like operations +-------------------- + +These methods provide functionality identical to that of a Python +`list`, with one exception: + +* When a field construct element needs to be assessed for equality, + its `~cf.Domain.equals` method is used, rather than the ``==`` + operator. This affects the `~cf.DomainList.count`, + `~cf.DomainList.index`, `~cf.DomainList.remove`, + `~cf.DomainList.__contains__`, `~cf.DomainList.__eq__` and + `~cf.DomainList.__ne__` methods. + +For example + +>>> fl.count(x) + +is equivalent to + +>>> sum(f.equals(x) for f in fl) + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.DomainList.append + ~cf.DomainList.clear + ~cf.DomainList.count + ~cf.DomainList.extend + ~cf.DomainList.index + ~cf.DomainList.insert + ~cf.DomainList.pop + ~cf.DomainList.remove + ~cf.DomainList.reverse + ~cf.DomainList.sort + ~cf.DomainList.__add__ + ~cf.DomainList.__contains__ + ~cf.DomainList.__eq__ + ~cf.DomainList.__ge__ + ~cf.DomainList.__getitem__ + ~cf.DomainList.__getslice__ + ~cf.DomainList.__gt__ + ~cf.DomainList.__iter__ + ~cf.DomainList.__iadd__ + ~cf.DomainList.__imul__ + ~cf.DomainList.__le__ + ~cf.DomainList.__len__ + ~cf.DomainList.__lt__ + ~cf.DomainList.__mul__ + ~cf.DomainList.__ne__ + ~cf.DomainList.__repr__ + ~cf.DomainList.__rmul__ + ~cf.DomainList.__setitem__ + ~cf.DomainList.__str__ + +Special methods +--------------- + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.DomainList.__call__ + ~cf.DomainList.__deepcopy__ + +.. ?? __hash__ + +Deprecated +---------- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.DomainList.select1 + ~cf.DomainList.set_equals From 04be91c21fd161d8406f3f309f97d612a5ce978f Mon Sep 17 00:00:00 2001 From: "Sadie L. Bartholomew" Date: Thu, 16 Jul 2026 18:20:34 +0100 Subject: [PATCH 02/13] Update API coverage checking script to check class coverage --- docs/source/check_docs_api_coverage.py | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/docs/source/check_docs_api_coverage.py b/docs/source/check_docs_api_coverage.py index 8cdd5f8aa2..0d753f60ca 100644 --- a/docs/source/check_docs_api_coverage.py +++ b/docs/source/check_docs_api_coverage.py @@ -12,6 +12,7 @@ """ +import inspect import os import sys @@ -32,6 +33,7 @@ n_undocumented_methods = 0 n_missing_files = 0 + for core in ("", "_core"): if core: if package.__name__ != "cfdm": @@ -44,29 +46,35 @@ api_contents = f.read() class_names = [ - i.split(".")[-1] - for i in api_contents.split("\n") - if package.__name__ + "." in i + name + for name, klass in inspect.getmembers(package, inspect.isclass) + if klass.__module__.startswith(package.__name__ + ".") ] for class_name in class_names: class_name = class_name.rstrip() + full_class_name = f"{package.__name__}.{class_name}" + + if full_class_name not in api_contents: + print(f"Class {full_class_name} not in class{core}.rst") + n_missing_files += 1 + continue + klass = getattr(package, class_name) methods = [ method for method in dir(klass) if not method.startswith("_") ] - class_name = ".".join([package.__name__, class_name]) - rst_file = os.path.join(source, "class", class_name + ".rst") + rst_file = os.path.join(source, "class", full_class_name + ".rst") try: with open(rst_file) as f: rst_contents = f.read() for method in methods: - method = ".".join([class_name, method]) + method = ".".join([full_class_name, method]) if method not in rst_contents: n_undocumented_methods += 1 print(f"Method {method} not in {rst_file}") From 1a9b3d9514a7dba8f7f623e5c431f460d863f54f Mon Sep 17 00:00:00 2001 From: "Sadie L. Bartholomew" Date: Thu, 16 Jul 2026 19:15:02 +0100 Subject: [PATCH 03/13] Handle metaclass functions in API coverage checking script --- docs/source/check_docs_api_coverage.py | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/source/check_docs_api_coverage.py b/docs/source/check_docs_api_coverage.py index 0d753f60ca..0cb921d1bb 100644 --- a/docs/source/check_docs_api_coverage.py +++ b/docs/source/check_docs_api_coverage.py @@ -45,10 +45,23 @@ with open(os.path.join(source, "class" + core + ".rst")) as f: api_contents = f.read() + # TODO: after #958 is resolved, replace this by grabbing all classes from + # '__all__', which defines the public API and therefore what must be + # include - and do the same for the methods etc. class_names = [ name for name, klass in inspect.getmembers(package, inspect.isclass) if klass.__module__.startswith(package.__name__ + ".") + # Because of docstring substitution in cfdm, all functions imported + # from there emerge as classes, with: + # type= + # so when we try to extract classes only we end up with a lot of + # functions mixed in. To filter these out, we can use the fact that + # the functions emerge from just some modules, notably .functions etc.: + and not klass.__module__.startswith(package.__name__ + ".functions") + and not klass.__module__.startswith(package.__name__ + ".constants") + # This just counts top-level read-write i.e. cf.read and cf.write + and not klass.__module__.startswith(package.__name__ + ".read_write") ] for class_name in class_names: From 9030df9c1b3ecb4f5af18694dbac600cf1cd801e Mon Sep 17 00:00:00 2001 From: "Sadie L. Bartholomew" Date: Thu, 16 Jul 2026 19:51:29 +0100 Subject: [PATCH 04/13] Update docs & messages for API coverage checking script --- docs/source/check_docs_api_coverage.py | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/source/check_docs_api_coverage.py b/docs/source/check_docs_api_coverage.py index 0cb921d1bb..fe6c26ea04 100644 --- a/docs/source/check_docs_api_coverage.py +++ b/docs/source/check_docs_api_coverage.py @@ -1,4 +1,6 @@ -"""Check the method-coverage of all classes in docs/source/class.rst. +"""Check the class-coverage and method-coverage of the API reference. + +All classes are extracted and checked for an entry in docs/source/class.rst All non-private methods of all such classes are checked for having an entry in their corresponding class's file in docs/source/class/ @@ -70,7 +72,7 @@ full_class_name = f"{package.__name__}.{class_name}" if full_class_name not in api_contents: - print(f"Class {full_class_name} not in class{core}.rst") + print(f"Class {full_class_name} not in docs/source/class{core}.rst") n_missing_files += 1 continue @@ -93,7 +95,7 @@ print(f"Method {method} not in {rst_file}") except FileNotFoundError: n_missing_files += 1 - print(f"File {rst_file} does not exist") + print(f"File {rst_file} does not exist for existing class ") if n_undocumented_methods or n_missing_files: raise ValueError( From ad8c66d2d90c2bc912db3f7d92c0adfd2816e4b0 Mon Sep 17 00:00:00 2001 From: "Sadie L. Bartholomew" Date: Thu, 16 Jul 2026 19:58:45 +0100 Subject: [PATCH 05/13] Add duplicate method checking logic from cfdm equivalent script --- docs/source/check_docs_api_coverage.py | 46 ++++++++++++++++++++++++-- 1 file changed, 43 insertions(+), 3 deletions(-) diff --git a/docs/source/check_docs_api_coverage.py b/docs/source/check_docs_api_coverage.py index fe6c26ea04..32463bedc9 100644 --- a/docs/source/check_docs_api_coverage.py +++ b/docs/source/check_docs_api_coverage.py @@ -15,6 +15,7 @@ """ import inspect +import re import os import sys @@ -32,9 +33,12 @@ if not source.endswith("source"): raise ValueError(f"Given directory {source} does not end with 'source'") +n_undocumented_classes = 0 n_undocumented_methods = 0 n_missing_files = 0 +duplicate_method_entries = [] + for core in ("", "_core"): if core: @@ -74,6 +78,7 @@ if full_class_name not in api_contents: print(f"Class {full_class_name} not in docs/source/class{core}.rst") n_missing_files += 1 + n_undocumented_classes += 1 continue klass = getattr(package, class_name) @@ -90,17 +95,52 @@ for method in methods: method = ".".join([full_class_name, method]) - if method not in rst_contents: + count = rst_contents.count(method) + if count == 0: n_undocumented_methods += 1 - print(f"Method {method} not in {rst_file}") + print( + f"Method {method} not in " + f"{os.path.join(source, 'class', rst_file)}" + ) + elif count > 1: + # The method appears more than once, but may be a + # sub-string of another method name, e.g. this gets caught: + # [cfdm.List.]nc_set_variable + # due to the presence of this method: + # [cfdm.List.]nc_set_variable_groups + # so we must account for that. Checking next character + # of duplicate(s) is something other than a newline or + # whitespace, seems robust and simplest. + end_loc = [ + m.end(0) for m in re.finditer(method, rst_contents) + ] + chars = [rst_contents[c] for c in [e for e in end_loc]] + + # Any character that isn't a newline or whitespace + # indicates another method which the method is a substring + # of and can be excluded. If there are still duplicates, + # we have genuine duplicate listing entries to report. + if chars.count("\n") + chars.count(" ") > 1: + duplicate_method_entries.append(method) + except FileNotFoundError: n_missing_files += 1 print(f"File {rst_file} does not exist for existing class ") if n_undocumented_methods or n_missing_files: raise ValueError( - f"Found {n_undocumented_methods} undocumented methods and " + f"Found {n_undocumented_classes} undocumented classes, " + f"{n_undocumented_methods} undocumented methods and " f"{n_missing_files} missing .rst files" ) +if duplicate_method_entries: + duplicate_method_entries.sort() + entries = "\n".join(duplicate_method_entries) # can't set \n in f-string! + print( + "WARNING: some methods are listed multiple times inside one class " + "file/page. Decide if the duplicates are intended and if not remove " + f"them. They are:\n{entries}\n" + ) + print("All methods are documented") From 63d72bf19d64d17ab2b03ab199fba75872b5af61 Mon Sep 17 00:00:00 2001 From: "Sadie L. Bartholomew" Date: Thu, 16 Jul 2026 23:12:28 +0100 Subject: [PATCH 06/13] Add missing classes to class.rst page listing --- docs/source/class.rst | 49 ++++++++++++++++++++++++++++++++++++------- 1 file changed, 42 insertions(+), 7 deletions(-) diff --git a/docs/source/class.rst b/docs/source/class.rst index 6031d91c94..ca79a35f7e 100644 --- a/docs/source/class.rst +++ b/docs/source/class.rst @@ -32,7 +32,16 @@ Domain class :toctree: class/ cf.Domain - + +Domain list class +----------------- + +.. autosummary:: + :nosignatures: + :toctree: class/ + + cf.DomainList + Metadata component classes -------------------------- @@ -51,15 +60,16 @@ Metadata component classes cf.DomainTopology cf.FieldAncillary -Constructs class ----------------- +Constructs classes +------------------ .. autosummary:: :nosignatures: :toctree: class/ cf.Constructs - + cf.ConstructList + Coordinate component classes ---------------------------- @@ -70,7 +80,8 @@ Coordinate component classes cf.Bounds cf.CoordinateConversion cf.Datum - + cf.InteriorRing + Data classes ------------ @@ -78,10 +89,13 @@ Data classes :nosignatures: :toctree: class/ + cf.AggregatedArray cf.Data cf.H5netcdfArray cf.NetCDF4Array cf.FullArray + cf.ScipyNetcdfFileArray + cf.PyfiveArray cf.UMArray cf.ZarrArray @@ -102,6 +116,7 @@ Classes that support the creation and storage of compressed arrays. cf.RaggedIndexedArray cf.RaggedIndexedContiguousArray cf.SubsampledArray + cf.TiePointIndex cf.Quantization Data UGRID classes @@ -116,7 +131,18 @@ Classes that support the creation and storage of UGRID-related arrays. cf.BoundsFromNodesArray cf.CellConnectivityArray cf.PointTopologyArray - + cf.NodeCountProperties + cf.PartNodeCountProperties + +CF Data Model Implementation class +---------------------------------- + +.. autosummary:: + :nosignatures: + :toctree: class/ + + cf.CFImplementation + Miscellaneous classes --------------------- @@ -131,4 +157,13 @@ Miscellaneous classes cf.RegridOperator cf.Constant cf.Configuration - + cf.InterpolationParameter + +Deprecated classes +------------------ + +.. autosummary:: + :nosignatures: + :toctree: class/ + + cf.NetCDFArray From 649b3cebf4ce0b8d620a55779a0b173773b7b86f Mon Sep 17 00:00:00 2001 From: "Sadie L. Bartholomew" Date: Fri, 17 Jul 2026 15:58:29 +0100 Subject: [PATCH 07/13] Update DomainList class API listing page to remove n/a methods --- docs/source/class/cf.DomainList.rst | 27 ++++----------------------- 1 file changed, 4 insertions(+), 23 deletions(-) diff --git a/docs/source/class/cf.DomainList.rst b/docs/source/class/cf.DomainList.rst index 410f782420..eb3b03dcc7 100644 --- a/docs/source/class/cf.DomainList.rst +++ b/docs/source/class/cf.DomainList.rst @@ -1,7 +1,7 @@ .. currentmodule:: cf .. default-role:: obj -.. _fieldlist: +.. _domainlist: cf.DomainList ============= @@ -22,15 +22,12 @@ Selecting ~cf.DomainList.select_by_construct ~cf.DomainList.select_by_identity - ~cf.DomainList.select_by_naxes ~cf.DomainList.select_by_ncvar ~cf.DomainList.select_by_property ~cf.DomainList.select_by_rank - ~cf.DomainList.select_by_units ~cf.DomainList.select - ~cf.DomainList.select_field ~cf.DomainList.__call__ - + Comparison ---------- @@ -64,7 +61,6 @@ Miscellaneous :template: method.rst ~cf.DomainList.close - ~cf.DomainList.concatenate ~cf.DomainList.copy Aliases @@ -93,11 +89,11 @@ These methods provide functionality identical to that of a Python For example ->>> fl.count(x) +>>> dl.count(x) is equivalent to ->>> sum(f.equals(x) for f in fl) +>>> sum(d.equals(x) for d in dl) .. autosummary:: :nosignatures: @@ -144,18 +140,3 @@ Special methods ~cf.DomainList.__call__ ~cf.DomainList.__deepcopy__ - -.. ?? __hash__ - -Deprecated ----------- - -.. rubric:: Methods - -.. autosummary:: - :nosignatures: - :toctree: ../method/ - :template: method.rst - - ~cf.DomainList.select1 - ~cf.DomainList.set_equals From 5587206a673e4794a44100107065ac86fae24819 Mon Sep 17 00:00:00 2001 From: "Sadie L. Bartholomew" Date: Fri, 17 Jul 2026 16:52:36 +0100 Subject: [PATCH 08/13] Add all missing classes to class.rst page listing --- docs/source/class/cf.InteriorRing.rst | 13 +++++++++++++ docs/source/class/cf.InterpolationParameter.rst | 13 +++++++++++++ docs/source/class/cf.NetCDFArray.rst | 13 +++++++++++++ docs/source/class/cf.NodeCountProperties.rst | 13 +++++++++++++ docs/source/class/cf.PartNodeCountProperties.rst | 13 +++++++++++++ docs/source/class/cf.PyfiveArray.rst | 13 +++++++++++++ docs/source/class/cf.ScipyNetcdfFileArray.rst | 13 +++++++++++++ docs/source/class/cf.TiePointIndex.rst | 13 +++++++++++++ 8 files changed, 104 insertions(+) create mode 100644 docs/source/class/cf.InteriorRing.rst create mode 100644 docs/source/class/cf.InterpolationParameter.rst create mode 100644 docs/source/class/cf.NetCDFArray.rst create mode 100644 docs/source/class/cf.NodeCountProperties.rst create mode 100644 docs/source/class/cf.PartNodeCountProperties.rst create mode 100644 docs/source/class/cf.PyfiveArray.rst create mode 100644 docs/source/class/cf.ScipyNetcdfFileArray.rst create mode 100644 docs/source/class/cf.TiePointIndex.rst diff --git a/docs/source/class/cf.InteriorRing.rst b/docs/source/class/cf.InteriorRing.rst new file mode 100644 index 0000000000..2170727ceb --- /dev/null +++ b/docs/source/class/cf.InteriorRing.rst @@ -0,0 +1,13 @@ +.. currentmodule:: cf +.. default-role:: obj + +.. _domainlist: + +cf.InteriorRing +=============== + +---- + +.. autoclass:: cf.InteriorRing + :no-members: + :no-inherited-members: diff --git a/docs/source/class/cf.InterpolationParameter.rst b/docs/source/class/cf.InterpolationParameter.rst new file mode 100644 index 0000000000..361c2f0548 --- /dev/null +++ b/docs/source/class/cf.InterpolationParameter.rst @@ -0,0 +1,13 @@ +.. currentmodule:: cf +.. default-role:: obj + +.. _domainlist: + +cf.InterpolationParameter +========================= + +---- + +.. autoclass:: cf.InterpolationParameter + :no-members: + :no-inherited-members: diff --git a/docs/source/class/cf.NetCDFArray.rst b/docs/source/class/cf.NetCDFArray.rst new file mode 100644 index 0000000000..2149947ed2 --- /dev/null +++ b/docs/source/class/cf.NetCDFArray.rst @@ -0,0 +1,13 @@ +.. currentmodule:: cf +.. default-role:: obj + +.. _domainlist: + +cf.NetCDFArray +============== + +---- + +.. autoclass:: cf.NetCDFArray + :no-members: + :no-inherited-members: diff --git a/docs/source/class/cf.NodeCountProperties.rst b/docs/source/class/cf.NodeCountProperties.rst new file mode 100644 index 0000000000..b2147073d8 --- /dev/null +++ b/docs/source/class/cf.NodeCountProperties.rst @@ -0,0 +1,13 @@ +.. currentmodule:: cf +.. default-role:: obj + +.. _domainlist: + +cf.NodeCountProperties +====================== + +---- + +.. autoclass:: cf.NodeCountProperties + :no-members: + :no-inherited-members: diff --git a/docs/source/class/cf.PartNodeCountProperties.rst b/docs/source/class/cf.PartNodeCountProperties.rst new file mode 100644 index 0000000000..3e82b3afed --- /dev/null +++ b/docs/source/class/cf.PartNodeCountProperties.rst @@ -0,0 +1,13 @@ +.. currentmodule:: cf +.. default-role:: obj + +.. _domainlist: + +cf.PartNodeCountProperties +========================== + +---- + +.. autoclass:: cf.PartNodeCountProperties + :no-members: + :no-inherited-members: diff --git a/docs/source/class/cf.PyfiveArray.rst b/docs/source/class/cf.PyfiveArray.rst new file mode 100644 index 0000000000..10177d8bee --- /dev/null +++ b/docs/source/class/cf.PyfiveArray.rst @@ -0,0 +1,13 @@ +.. currentmodule:: cf +.. default-role:: obj + +.. _domainlist: + +cf.PyfiveArray +============== + +---- + +.. autoclass:: cf.PyfiveArray + :no-members: + :no-inherited-members: diff --git a/docs/source/class/cf.ScipyNetcdfFileArray.rst b/docs/source/class/cf.ScipyNetcdfFileArray.rst new file mode 100644 index 0000000000..a5207daebc --- /dev/null +++ b/docs/source/class/cf.ScipyNetcdfFileArray.rst @@ -0,0 +1,13 @@ +.. currentmodule:: cf +.. default-role:: obj + +.. _domainlist: + +cf.ScipyNetcdfFileArray +======================= + +---- + +.. autoclass:: cf.ScipyNetcdfFileArray + :no-members: + :no-inherited-members: diff --git a/docs/source/class/cf.TiePointIndex.rst b/docs/source/class/cf.TiePointIndex.rst new file mode 100644 index 0000000000..dd4472f051 --- /dev/null +++ b/docs/source/class/cf.TiePointIndex.rst @@ -0,0 +1,13 @@ +.. currentmodule:: cf +.. default-role:: obj + +.. _domainlist: + +cf.TiePointIndex +================ + +---- + +.. autoclass:: cf.TiePointIndex + :no-members: + :no-inherited-members: From b59d5416e99e07d733c54c5bcf9800e10284844f Mon Sep 17 00:00:00 2001 From: "Sadie L. Bartholomew" Date: Fri, 17 Jul 2026 17:27:49 +0100 Subject: [PATCH 09/13] Add undocumented methods to new API reference class stub files --- docs/source/class/cf.Field.rst | 2 +- .../class/cf.PartNodeCountProperties.rst | 68 +++++- docs/source/class/cf.PyfiveArray.rst | 47 +++- docs/source/class/cf.ScipyNetcdfFileArray.rst | 44 +++- docs/source/class/cf.TiePointIndex.rst | 208 +++++++++++++++++- 5 files changed, 363 insertions(+), 6 deletions(-) diff --git a/docs/source/class/cf.Field.rst b/docs/source/class/cf.Field.rst index 07a4995918..375208deda 100644 --- a/docs/source/class/cf.Field.rst +++ b/docs/source/class/cf.Field.rst @@ -26,7 +26,7 @@ Inspection :template: method.rst ~cf.Field.dump - ~cf.Field.identity + ~cf.Field.identity ~cf.Field.identities ~cf.Field.inspect diff --git a/docs/source/class/cf.PartNodeCountProperties.rst b/docs/source/class/cf.PartNodeCountProperties.rst index 3e82b3afed..5031a89b9b 100644 --- a/docs/source/class/cf.PartNodeCountProperties.rst +++ b/docs/source/class/cf.PartNodeCountProperties.rst @@ -1,13 +1,77 @@ .. currentmodule:: cf .. default-role:: obj -.. _domainlist: +.. _partnodecountproperties: cf.PartNodeCountProperties ========================== ---- -.. autoclass:: cf.PartNodeCountProperties +.. autoclass:: cf.PPartNodeCountProperties :no-members: :no-inherited-members: + + +Methods +------- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.PartNodeCountProperties.calendar + ~cf.PartNodeCountProperties.clear_properties + ~cf.PartNodeCountProperties.comment + ~cf.PartNodeCountProperties.copy + ~cf.PartNodeCountProperties.creation_commands + ~cf.PartNodeCountProperties.del_properties + ~cf.PartNodeCountProperties.del_property + ~cf.PartNodeCountProperties.delprop + ~cf.PartNodeCountProperties.dump + ~cf.PartNodeCountProperties.equals + ~cf.PartNodeCountProperties.get_original_filenames + ~cf.PartNodeCountProperties.get_property + ~cf.PartNodeCountProperties.getprop + ~cf.PartNodeCountProperties.has_bounds + ~cf.PartNodeCountProperties.has_data + ~cf.PartNodeCountProperties.has_property + ~cf.PartNodeCountProperties.hasprop + ~cf.PartNodeCountProperties.history + ~cf.PartNodeCountProperties.id + ~cf.PartNodeCountProperties.identities + ~cf.PartNodeCountProperties.identity + ~cf.PartNodeCountProperties.leap_month + ~cf.PartNodeCountProperties.leap_year + ~cf.PartNodeCountProperties.long_name + ~cf.PartNodeCountProperties.match + ~cf.PartNodeCountProperties.match_by_identity + ~cf.PartNodeCountProperties.match_by_ncvar + ~cf.PartNodeCountProperties.match_by_property + ~cf.PartNodeCountProperties.month_lengths + ~cf.PartNodeCountProperties.nc_clear_dimension_groups + ~cf.PartNodeCountProperties.nc_clear_variable_groups + ~cf.PartNodeCountProperties.nc_del_dimension + ~cf.PartNodeCountProperties.nc_del_variable + ~cf.PartNodeCountProperties.nc_dimension_groups + ~cf.PartNodeCountProperties.nc_get_dimension + ~cf.PartNodeCountProperties.nc_get_variable + ~cf.PartNodeCountProperties.nc_has_dimension + ~cf.PartNodeCountProperties.nc_has_variable + ~cf.PartNodeCountProperties.nc_set_dimension + ~cf.PartNodeCountProperties.nc_set_dimension_groups + ~cf.PartNodeCountProperties.nc_set_variable + ~cf.PartNodeCountProperties.nc_set_variable_groups + ~cf.PartNodeCountProperties.nc_variable_groups + ~cf.PartNodeCountProperties.properties + ~cf.PartNodeCountProperties.set_properties + ~cf.PartNodeCountProperties.set_property + ~cf.PartNodeCountProperties.setprop + ~cf.PartNodeCountProperties.standard_name + ~cf.PartNodeCountProperties.units + ~cf.PartNodeCountProperties.valid_max + ~cf.PartNodeCountProperties.valid_min + ~cf.PartNodeCountProperties.valid_range diff --git a/docs/source/class/cf.PyfiveArray.rst b/docs/source/class/cf.PyfiveArray.rst index 10177d8bee..8273dcd445 100644 --- a/docs/source/class/cf.PyfiveArray.rst +++ b/docs/source/class/cf.PyfiveArray.rst @@ -1,7 +1,7 @@ .. currentmodule:: cf .. default-role:: obj -.. _domainlist: +.. _pyfivearray: cf.PyfiveArray ============== @@ -11,3 +11,48 @@ cf.PyfiveArray .. autoclass:: cf.PyfiveArray :no-members: :no-inherited-members: + + +Methods +------- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.PyfiveArray.Units + ~cf.PyfiveArray.active_storage + ~cf.PyfiveArray.array + ~cf.PyfiveArray.astype + ~cf.PyfiveArray.close + ~cf.PyfiveArray.copy + ~cf.PyfiveArray.dtype + ~cf.PyfiveArray.file_directory + ~cf.PyfiveArray.get_address + ~cf.PyfiveArray.get_attributes + ~cf.PyfiveArray.get_calendar + ~cf.PyfiveArray.get_compression_type + ~cf.PyfiveArray.get_filename + ~cf.PyfiveArray.get_groups + ~cf.PyfiveArray.get_mask + ~cf.PyfiveArray.get_missing_values + ~cf.PyfiveArray.get_storage_options + ~cf.PyfiveArray.get_storage_protocol + ~cf.PyfiveArray.get_units + ~cf.PyfiveArray.get_unpack + ~cf.PyfiveArray.get_variable + ~cf.PyfiveArray.has_remote_storage_protocol + ~cf.PyfiveArray.index + ~cf.PyfiveArray.is_subspace + ~cf.PyfiveArray.ndim + ~cf.PyfiveArray.open + ~cf.PyfiveArray.original_shape + ~cf.PyfiveArray.reference_shape + ~cf.PyfiveArray.replace_directory + ~cf.PyfiveArray.replace_filename + ~cf.PyfiveArray.shape + ~cf.PyfiveArray.size + ~cf.PyfiveArray.to_memory diff --git a/docs/source/class/cf.ScipyNetcdfFileArray.rst b/docs/source/class/cf.ScipyNetcdfFileArray.rst index a5207daebc..ad08518ae3 100644 --- a/docs/source/class/cf.ScipyNetcdfFileArray.rst +++ b/docs/source/class/cf.ScipyNetcdfFileArray.rst @@ -1,7 +1,7 @@ .. currentmodule:: cf .. default-role:: obj -.. _domainlist: +.. _scipynetcdffilearray: cf.ScipyNetcdfFileArray ======================= @@ -11,3 +11,45 @@ cf.ScipyNetcdfFileArray .. autoclass:: cf.ScipyNetcdfFileArray :no-members: :no-inherited-members: + +Methods +------- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + cf.ScipyNetcdfFileArray.Units + cf.ScipyNetcdfFileArray.array + cf.ScipyNetcdfFileArray.astype + cf.ScipyNetcdfFileArray.close + cf.ScipyNetcdfFileArray.copy + cf.ScipyNetcdfFileArray.dtype + cf.ScipyNetcdfFileArray.file_directory + cf.ScipyNetcdfFileArray.get_address + cf.ScipyNetcdfFileArray.get_attributes + cf.ScipyNetcdfFileArray.get_calendar + cf.ScipyNetcdfFileArray.get_compression_type + cf.ScipyNetcdfFileArray.get_filename + cf.ScipyNetcdfFileArray.get_mask + cf.ScipyNetcdfFileArray.get_missing_values + cf.ScipyNetcdfFileArray.get_storage_options + cf.ScipyNetcdfFileArray.get_storage_protocol + cf.ScipyNetcdfFileArray.get_units + cf.ScipyNetcdfFileArray.get_unpack + cf.ScipyNetcdfFileArray.get_variable + cf.ScipyNetcdfFileArray.has_remote_storage_protocol + cf.ScipyNetcdfFileArray.index + cf.ScipyNetcdfFileArray.is_subspace + cf.ScipyNetcdfFileArray.ndim + cf.ScipyNetcdfFileArray.open + cf.ScipyNetcdfFileArray.original_shape + cf.ScipyNetcdfFileArray.reference_shape + cf.ScipyNetcdfFileArray.replace_directory + cf.ScipyNetcdfFileArray.replace_filename + cf.ScipyNetcdfFileArray.shape + cf.ScipyNetcdfFileArray.size + cf.ScipyNetcdfFileArray.to_memory diff --git a/docs/source/class/cf.TiePointIndex.rst b/docs/source/class/cf.TiePointIndex.rst index dd4472f051..5e551af37f 100644 --- a/docs/source/class/cf.TiePointIndex.rst +++ b/docs/source/class/cf.TiePointIndex.rst @@ -1,7 +1,7 @@ .. currentmodule:: cf .. default-role:: obj -.. _domainlist: +.. _tiepointindex: cf.TiePointIndex ================ @@ -11,3 +11,209 @@ cf.TiePointIndex .. autoclass:: cf.TiePointIndex :no-members: :no-inherited-members: + +Methods +------- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.TiePointIndex.Data + ~cf.TiePointIndex.T + ~cf.TiePointIndex.Units + ~cf.TiePointIndex.X + ~cf.TiePointIndex.Y + ~cf.TiePointIndex.Z + ~cf.TiePointIndex.add_offset + ~cf.TiePointIndex.all + ~cf.TiePointIndex.allclose + ~cf.TiePointIndex.any + ~cf.TiePointIndex.apply_masking + ~cf.TiePointIndex.arccos + ~cf.TiePointIndex.arccosh + ~cf.TiePointIndex.arcsin + ~cf.TiePointIndex.arcsinh + ~cf.TiePointIndex.arctan + ~cf.TiePointIndex.arctanh + ~cf.TiePointIndex.array + ~cf.TiePointIndex.asdatetime + ~cf.TiePointIndex.asreftime + ~cf.TiePointIndex.attributes + ~cf.TiePointIndex.binary_mask + ~cf.TiePointIndex.calendar + ~cf.TiePointIndex.ceil + ~cf.TiePointIndex.chunk + ~cf.TiePointIndex.clear_properties + ~cf.TiePointIndex.clip + ~cf.TiePointIndex.close + ~cf.TiePointIndex.comment + ~cf.TiePointIndex.concatenate + ~cf.TiePointIndex.convert_reference_time + ~cf.TiePointIndex.copy + ~cf.TiePointIndex.cos + ~cf.TiePointIndex.cosh + ~cf.TiePointIndex.count + ~cf.TiePointIndex.count_masked + ~cf.TiePointIndex.creation_commands + ~cf.TiePointIndex.cyclic + ~cf.TiePointIndex.data + ~cf.TiePointIndex.datetime_array + ~cf.TiePointIndex.datum + ~cf.TiePointIndex.day + ~cf.TiePointIndex.del_data + ~cf.TiePointIndex.del_properties + ~cf.TiePointIndex.del_property + ~cf.TiePointIndex.delprop + ~cf.TiePointIndex.dtarray + ~cf.TiePointIndex.dtvarray + ~cf.TiePointIndex.dtype + ~cf.TiePointIndex.dump + ~cf.TiePointIndex.equals + ~cf.TiePointIndex.equivalent + ~cf.TiePointIndex.exp + ~cf.TiePointIndex.expand_dims + ~cf.TiePointIndex.file_directories + ~cf.TiePointIndex.fill_value + ~cf.TiePointIndex.filled + ~cf.TiePointIndex.flatten + ~cf.TiePointIndex.flip + ~cf.TiePointIndex.floor + ~cf.TiePointIndex.get_data + ~cf.TiePointIndex.get_filenames + ~cf.TiePointIndex.get_original_filenames + ~cf.TiePointIndex.get_property + ~cf.TiePointIndex.get_quantization + ~cf.TiePointIndex.get_quantize_on_write + ~cf.TiePointIndex.getprop + ~cf.TiePointIndex.halo + ~cf.TiePointIndex.hardmask + ~cf.TiePointIndex.has_bounds + ~cf.TiePointIndex.has_data + ~cf.TiePointIndex.has_property + ~cf.TiePointIndex.hasbounds + ~cf.TiePointIndex.hasdata + ~cf.TiePointIndex.hasprop + ~cf.TiePointIndex.history + ~cf.TiePointIndex.hour + ~cf.TiePointIndex.id + ~cf.TiePointIndex.identities + ~cf.TiePointIndex.identity + ~cf.TiePointIndex.insert_data + ~cf.TiePointIndex.insert_dimension + ~cf.TiePointIndex.inspect + ~cf.TiePointIndex.isauxiliary + ~cf.TiePointIndex.iscyclic + ~cf.TiePointIndex.isdimension + ~cf.TiePointIndex.isdomainancillary + ~cf.TiePointIndex.isfieldancillary + ~cf.TiePointIndex.ismeasure + ~cf.TiePointIndex.isperiodic + ~cf.TiePointIndex.isscalar + ~cf.TiePointIndex.leap_month + ~cf.TiePointIndex.leap_year + ~cf.TiePointIndex.log + ~cf.TiePointIndex.long_name + ~cf.TiePointIndex.mask + ~cf.TiePointIndex.mask_invalid + ~cf.TiePointIndex.masked_invalid + ~cf.TiePointIndex.match + ~cf.TiePointIndex.match_by_identity + ~cf.TiePointIndex.match_by_naxes + ~cf.TiePointIndex.match_by_ncvar + ~cf.TiePointIndex.match_by_property + ~cf.TiePointIndex.match_by_units + ~cf.TiePointIndex.max + ~cf.TiePointIndex.maximum + ~cf.TiePointIndex.mean + ~cf.TiePointIndex.mid_range + ~cf.TiePointIndex.min + ~cf.TiePointIndex.minimum + ~cf.TiePointIndex.minute + ~cf.TiePointIndex.missing_value + ~cf.TiePointIndex.month + ~cf.TiePointIndex.month_lengths + ~cf.TiePointIndex.name + ~cf.TiePointIndex.nc_clear_dataset_chunksizes + ~cf.TiePointIndex.nc_clear_hdf5_chunksizes + ~cf.TiePointIndex.nc_clear_interpolation_subarea_dimension_groups + ~cf.TiePointIndex.nc_clear_subsampled_dimension_groups + ~cf.TiePointIndex.nc_clear_variable_groups + ~cf.TiePointIndex.nc_dataset_chunksizes + ~cf.TiePointIndex.nc_del_interpolation_subarea_dimension + ~cf.TiePointIndex.nc_del_subsampled_dimension + ~cf.TiePointIndex.nc_del_variable + ~cf.TiePointIndex.nc_get_interpolation_subarea_dimension + ~cf.TiePointIndex.nc_get_subsampled_dimension + ~cf.TiePointIndex.nc_get_variable + ~cf.TiePointIndex.nc_has_interpolation_subarea_dimension + ~cf.TiePointIndex.nc_has_subsampled_dimension + ~cf.TiePointIndex.nc_has_variable + ~cf.TiePointIndex.nc_hdf5_chunksizes + ~cf.TiePointIndex.nc_interpolation_subarea_dimension_groups + ~cf.TiePointIndex.nc_set_dataset_chunksizes + ~cf.TiePointIndex.nc_set_hdf5_chunksizes + ~cf.TiePointIndex.nc_set_interpolation_subarea_dimension + ~cf.TiePointIndex.nc_set_interpolation_subarea_dimension_groups + ~cf.TiePointIndex.nc_set_subsampled_dimension + ~cf.TiePointIndex.nc_set_subsampled_dimension_groups + ~cf.TiePointIndex.nc_set_variable + ~cf.TiePointIndex.nc_set_variable_groups + ~cf.TiePointIndex.nc_subsampled_dimension_groups + ~cf.TiePointIndex.nc_variable_groups + ~cf.TiePointIndex.ndim + ~cf.TiePointIndex.override_calendar + ~cf.TiePointIndex.override_units + ~cf.TiePointIndex.pad_missing + ~cf.TiePointIndex.period + ~cf.TiePointIndex.persist + ~cf.TiePointIndex.properties + ~cf.TiePointIndex.range + ~cf.TiePointIndex.rechunk + ~cf.TiePointIndex.reference_datetime + ~cf.TiePointIndex.remove_data + ~cf.TiePointIndex.replace_directory + ~cf.TiePointIndex.rint + ~cf.TiePointIndex.roll + ~cf.TiePointIndex.round + ~cf.TiePointIndex.sample_size + ~cf.TiePointIndex.scale_factor + ~cf.TiePointIndex.sd + ~cf.TiePointIndex.second + ~cf.TiePointIndex.select + ~cf.TiePointIndex.set_data + ~cf.TiePointIndex.set_properties + ~cf.TiePointIndex.set_property + ~cf.TiePointIndex.setprop + ~cf.TiePointIndex.shape + ~cf.TiePointIndex.sin + ~cf.TiePointIndex.sinh + ~cf.TiePointIndex.size + ~cf.TiePointIndex.squeeze + ~cf.TiePointIndex.standard_deviation + ~cf.TiePointIndex.standard_name + ~cf.TiePointIndex.subspace + ~cf.TiePointIndex.sum + ~cf.TiePointIndex.swapaxes + ~cf.TiePointIndex.tan + ~cf.TiePointIndex.tanh + ~cf.TiePointIndex.to_dask_array + ~cf.TiePointIndex.to_memory + ~cf.TiePointIndex.to_units + ~cf.TiePointIndex.transpose + ~cf.TiePointIndex.trunc + ~cf.TiePointIndex.uncompress + ~cf.TiePointIndex.unique + ~cf.TiePointIndex.units + ~cf.TiePointIndex.unsafe_array + ~cf.TiePointIndex.valid_max + ~cf.TiePointIndex.valid_min + ~cf.TiePointIndex.valid_range + ~cf.TiePointIndex.var + ~cf.TiePointIndex.variance + ~cf.TiePointIndex.varray + ~cf.TiePointIndex.where + ~cf.TiePointIndex.year From 19bc630a8dbeda78abe0894e4f066146eb3899d7 Mon Sep 17 00:00:00 2001 From: "Sadie L. Bartholomew" Date: Fri, 17 Jul 2026 17:32:38 +0100 Subject: [PATCH 10/13] Add remaining undoc'd methods to new API ref. class stub files --- docs/source/class/cf.InteriorRing.rst | 201 +++++++++++++++++- .../class/cf.InterpolationParameter.rst | 194 ++++++++++++++++- docs/source/class/cf.NodeCountProperties.rst | 58 ++++- 3 files changed, 450 insertions(+), 3 deletions(-) diff --git a/docs/source/class/cf.InteriorRing.rst b/docs/source/class/cf.InteriorRing.rst index 2170727ceb..255c5ca967 100644 --- a/docs/source/class/cf.InteriorRing.rst +++ b/docs/source/class/cf.InteriorRing.rst @@ -1,7 +1,7 @@ .. currentmodule:: cf .. default-role:: obj -.. _domainlist: +.. _interiorring: cf.InteriorRing =============== @@ -11,3 +11,202 @@ cf.InteriorRing .. autoclass:: cf.InteriorRing :no-members: :no-inherited-members: + +Methods +------- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.InteriorRing.Data + ~cf.InteriorRing.T + ~cf.InteriorRing.Units + ~cf.InteriorRing.X + ~cf.InteriorRing.Y + ~cf.InteriorRing.Z + ~cf.InteriorRing.add_offset + ~cf.InteriorRing.all + ~cf.InteriorRing.allclose + ~cf.InteriorRing.any + ~cf.InteriorRing.apply_masking + ~cf.InteriorRing.arccos + ~cf.InteriorRing.arccosh + ~cf.InteriorRing.arcsin + ~cf.InteriorRing.arcsinh + ~cf.InteriorRing.arctan + ~cf.InteriorRing.arctanh + ~cf.InteriorRing.array + ~cf.InteriorRing.asdatetime + ~cf.InteriorRing.asreftime + ~cf.InteriorRing.attributes + ~cf.InteriorRing.binary_mask + ~cf.InteriorRing.calendar + ~cf.InteriorRing.ceil + ~cf.InteriorRing.chunk + ~cf.InteriorRing.clear_properties + ~cf.InteriorRing.clip + ~cf.InteriorRing.close + ~cf.InteriorRing.comment + ~cf.InteriorRing.concatenate + ~cf.InteriorRing.convert_reference_time + ~cf.InteriorRing.copy + ~cf.InteriorRing.cos + ~cf.InteriorRing.cosh + ~cf.InteriorRing.count + ~cf.InteriorRing.count_masked + ~cf.InteriorRing.creation_commands + ~cf.InteriorRing.cyclic + ~cf.InteriorRing.data + ~cf.InteriorRing.datetime_array + ~cf.InteriorRing.datum + ~cf.InteriorRing.day + ~cf.InteriorRing.del_data + ~cf.InteriorRing.del_properties + ~cf.InteriorRing.del_property + ~cf.InteriorRing.delprop + ~cf.InteriorRing.dtarray + ~cf.InteriorRing.dtvarray + ~cf.InteriorRing.dtype + ~cf.InteriorRing.dump + ~cf.InteriorRing.equals + ~cf.InteriorRing.equivalent + ~cf.InteriorRing.exp + ~cf.InteriorRing.expand_dims + ~cf.InteriorRing.file_directories + ~cf.InteriorRing.fill_value + ~cf.InteriorRing.filled + ~cf.InteriorRing.flatten + ~cf.InteriorRing.flip + ~cf.InteriorRing.floor + ~cf.InteriorRing.get_data + ~cf.InteriorRing.get_filenames + ~cf.InteriorRing.get_original_filenames + ~cf.InteriorRing.get_property + ~cf.InteriorRing.get_quantization + ~cf.InteriorRing.get_quantize_on_write + ~cf.InteriorRing.getprop + ~cf.InteriorRing.halo + ~cf.InteriorRing.hardmask + ~cf.InteriorRing.has_bounds + ~cf.InteriorRing.has_data + ~cf.InteriorRing.has_property + ~cf.InteriorRing.hasbounds + ~cf.InteriorRing.hasdata + ~cf.InteriorRing.hasprop + ~cf.InteriorRing.history + ~cf.InteriorRing.hour + ~cf.InteriorRing.id + ~cf.InteriorRing.identities + ~cf.InteriorRing.identity + ~cf.InteriorRing.insert_data + ~cf.InteriorRing.insert_dimension + ~cf.InteriorRing.inspect + ~cf.InteriorRing.isauxiliary + ~cf.InteriorRing.iscyclic + ~cf.InteriorRing.isdimension + ~cf.InteriorRing.isdomainancillary + ~cf.InteriorRing.isfieldancillary + ~cf.InteriorRing.ismeasure + ~cf.InteriorRing.isperiodic + ~cf.InteriorRing.isscalar + ~cf.InteriorRing.leap_month + ~cf.InteriorRing.leap_year + ~cf.InteriorRing.log + ~cf.InteriorRing.long_name + ~cf.InteriorRing.mask + ~cf.InteriorRing.mask_invalid + ~cf.InteriorRing.masked_invalid + ~cf.InteriorRing.match + ~cf.InteriorRing.match_by_identity + ~cf.InteriorRing.match_by_naxes + ~cf.InteriorRing.match_by_ncvar + ~cf.InteriorRing.match_by_property + ~cf.InteriorRing.match_by_units + ~cf.InteriorRing.max + ~cf.InteriorRing.maximum + ~cf.InteriorRing.mean + ~cf.InteriorRing.mid_range + ~cf.InteriorRing.min + ~cf.InteriorRing.minimum + ~cf.InteriorRing.minute + ~cf.InteriorRing.missing_value + ~cf.InteriorRing.month + ~cf.InteriorRing.month_lengths + ~cf.InteriorRing.name + ~cf.InteriorRing.nc_clear_dataset_chunksizes + ~cf.InteriorRing.nc_clear_dimension_groups + ~cf.InteriorRing.nc_clear_hdf5_chunksizes + ~cf.InteriorRing.nc_clear_variable_groups + ~cf.InteriorRing.nc_dataset_chunksizes + ~cf.InteriorRing.nc_del_dimension + ~cf.InteriorRing.nc_del_variable + ~cf.InteriorRing.nc_dimension_groups + ~cf.InteriorRing.nc_get_dimension + ~cf.InteriorRing.nc_get_variable + ~cf.InteriorRing.nc_has_dimension + ~cf.InteriorRing.nc_has_variable + ~cf.InteriorRing.nc_hdf5_chunksizes + ~cf.InteriorRing.nc_set_dataset_chunksizes + ~cf.InteriorRing.nc_set_dimension + ~cf.InteriorRing.nc_set_dimension_groups + ~cf.InteriorRing.nc_set_hdf5_chunksizes + ~cf.InteriorRing.nc_set_variable + ~cf.InteriorRing.nc_set_variable_groups + ~cf.InteriorRing.nc_variable_groups + ~cf.InteriorRing.ndim + ~cf.InteriorRing.override_calendar + ~cf.InteriorRing.override_units + ~cf.InteriorRing.pad_missing + ~cf.InteriorRing.period + ~cf.InteriorRing.persist + ~cf.InteriorRing.properties + ~cf.InteriorRing.range + ~cf.InteriorRing.rechunk + ~cf.InteriorRing.reference_datetime + ~cf.InteriorRing.remove_data + ~cf.InteriorRing.replace_directory + ~cf.InteriorRing.rint + ~cf.InteriorRing.roll + ~cf.InteriorRing.round + ~cf.InteriorRing.sample_size + ~cf.InteriorRing.scale_factor + ~cf.InteriorRing.sd + ~cf.InteriorRing.second + ~cf.InteriorRing.select + ~cf.InteriorRing.set_data + ~cf.InteriorRing.set_properties + ~cf.InteriorRing.set_property + ~cf.InteriorRing.setprop + ~cf.InteriorRing.shape + ~cf.InteriorRing.sin + ~cf.InteriorRing.sinh + ~cf.InteriorRing.size + ~cf.InteriorRing.squeeze + ~cf.InteriorRing.standard_deviation + ~cf.InteriorRing.standard_name + ~cf.InteriorRing.subspace + ~cf.InteriorRing.sum + ~cf.InteriorRing.swapaxes + ~cf.InteriorRing.tan + ~cf.InteriorRing.tanh + ~cf.InteriorRing.to_dask_array + ~cf.InteriorRing.to_memory + ~cf.InteriorRing.to_units + ~cf.InteriorRing.transpose + ~cf.InteriorRing.trunc + ~cf.InteriorRing.uncompress + ~cf.InteriorRing.unique + ~cf.InteriorRing.units + ~cf.InteriorRing.unsafe_array + ~cf.InteriorRing.valid_max + ~cf.InteriorRing.valid_min + ~cf.InteriorRing.valid_range + ~cf.InteriorRing.var + ~cf.InteriorRing.variance + ~cf.InteriorRing.varray + ~cf.InteriorRing.where + ~cf.InteriorRing.year diff --git a/docs/source/class/cf.InterpolationParameter.rst b/docs/source/class/cf.InterpolationParameter.rst index 361c2f0548..e7e877250d 100644 --- a/docs/source/class/cf.InterpolationParameter.rst +++ b/docs/source/class/cf.InterpolationParameter.rst @@ -1,7 +1,7 @@ .. currentmodule:: cf .. default-role:: obj -.. _domainlist: +.. _interpolationparameter: cf.InterpolationParameter ========================= @@ -11,3 +11,195 @@ cf.InterpolationParameter .. autoclass:: cf.InterpolationParameter :no-members: :no-inherited-members: + +Methods +------- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.InterpolationParameter.Data + ~cf.InterpolationParameter.T + ~cf.InterpolationParameter.Units + ~cf.InterpolationParameter.X + ~cf.InterpolationParameter.Y + ~cf.InterpolationParameter.Z + ~cf.InterpolationParameter.add_offset + ~cf.InterpolationParameter.all + ~cf.InterpolationParameter.allclose + ~cf.InterpolationParameter.any + ~cf.InterpolationParameter.apply_masking + ~cf.InterpolationParameter.arccos + ~cf.InterpolationParameter.arccosh + ~cf.InterpolationParameter.arcsin + ~cf.InterpolationParameter.arcsinh + ~cf.InterpolationParameter.arctan + ~cf.InterpolationParameter.arctanh + ~cf.InterpolationParameter.array + ~cf.InterpolationParameter.asdatetime + ~cf.InterpolationParameter.asreftime + ~cf.InterpolationParameter.attributes + ~cf.InterpolationParameter.binary_mask + ~cf.InterpolationParameter.calendar + ~cf.InterpolationParameter.ceil + ~cf.InterpolationParameter.chunk + ~cf.InterpolationParameter.clear_properties + ~cf.InterpolationParameter.clip + ~cf.InterpolationParameter.close + ~cf.InterpolationParameter.comment + ~cf.InterpolationParameter.concatenate + ~cf.InterpolationParameter.convert_reference_time + ~cf.InterpolationParameter.copy + ~cf.InterpolationParameter.cos + ~cf.InterpolationParameter.cosh + ~cf.InterpolationParameter.count + ~cf.InterpolationParameter.count_masked + ~cf.InterpolationParameter.creation_commands + ~cf.InterpolationParameter.cyclic + ~cf.InterpolationParameter.data + ~cf.InterpolationParameter.datetime_array + ~cf.InterpolationParameter.datum + ~cf.InterpolationParameter.day + ~cf.InterpolationParameter.del_data + ~cf.InterpolationParameter.del_properties + ~cf.InterpolationParameter.del_property + ~cf.InterpolationParameter.delprop + ~cf.InterpolationParameter.dtarray + ~cf.InterpolationParameter.dtvarray + ~cf.InterpolationParameter.dtype + ~cf.InterpolationParameter.dump + ~cf.InterpolationParameter.equals + ~cf.InterpolationParameter.equivalent + ~cf.InterpolationParameter.exp + ~cf.InterpolationParameter.expand_dims + ~cf.InterpolationParameter.file_directories + ~cf.InterpolationParameter.fill_value + ~cf.InterpolationParameter.filled + ~cf.InterpolationParameter.flatten + ~cf.InterpolationParameter.flip + ~cf.InterpolationParameter.floor + ~cf.InterpolationParameter.get_data + ~cf.InterpolationParameter.get_filenames + ~cf.InterpolationParameter.get_original_filenames + ~cf.InterpolationParameter.get_property + ~cf.InterpolationParameter.get_quantization + ~cf.InterpolationParameter.get_quantize_on_write + ~cf.InterpolationParameter.getprop + ~cf.InterpolationParameter.halo + ~cf.InterpolationParameter.hardmask + ~cf.InterpolationParameter.has_bounds + ~cf.InterpolationParameter.has_data + ~cf.InterpolationParameter.has_property + ~cf.InterpolationParameter.hasbounds + ~cf.InterpolationParameter.hasdata + ~cf.InterpolationParameter.hasprop + ~cf.InterpolationParameter.history + ~cf.InterpolationParameter.hour + ~cf.InterpolationParameter.id + ~cf.InterpolationParameter.identities + ~cf.InterpolationParameter.identity + ~cf.InterpolationParameter.insert_data + ~cf.InterpolationParameter.insert_dimension + ~cf.InterpolationParameter.inspect + ~cf.InterpolationParameter.isauxiliary + ~cf.InterpolationParameter.iscyclic + ~cf.InterpolationParameter.isdimension + ~cf.InterpolationParameter.isdomainancillary + ~cf.InterpolationParameter.isfieldancillary + ~cf.InterpolationParameter.ismeasure + ~cf.InterpolationParameter.isperiodic + ~cf.InterpolationParameter.isscalar + ~cf.InterpolationParameter.leap_month + ~cf.InterpolationParameter.leap_year + ~cf.InterpolationParameter.log + ~cf.InterpolationParameter.long_name + ~cf.InterpolationParameter.mask + ~cf.InterpolationParameter.mask_invalid + ~cf.InterpolationParameter.masked_invalid + ~cf.InterpolationParameter.match + ~cf.InterpolationParameter.match_by_identity + ~cf.InterpolationParameter.match_by_naxes + ~cf.InterpolationParameter.match_by_ncvar + ~cf.InterpolationParameter.match_by_property + ~cf.InterpolationParameter.match_by_units + ~cf.InterpolationParameter.max + ~cf.InterpolationParameter.maximum + ~cf.InterpolationParameter.mean + ~cf.InterpolationParameter.mid_range + ~cf.InterpolationParameter.min + ~cf.InterpolationParameter.minimum + ~cf.InterpolationParameter.minute + ~cf.InterpolationParameter.missing_value + ~cf.InterpolationParameter.month + ~cf.InterpolationParameter.month_lengths + ~cf.InterpolationParameter.name + ~cf.InterpolationParameter.nc_clear_dataset_chunksizes + ~cf.InterpolationParameter.nc_clear_hdf5_chunksizes + ~cf.InterpolationParameter.nc_clear_variable_groups + ~cf.InterpolationParameter.nc_dataset_chunksizes + ~cf.InterpolationParameter.nc_del_variable + ~cf.InterpolationParameter.nc_get_variable + ~cf.InterpolationParameter.nc_has_variable + ~cf.InterpolationParameter.nc_hdf5_chunksizes + ~cf.InterpolationParameter.nc_set_dataset_chunksizes + ~cf.InterpolationParameter.nc_set_hdf5_chunksizes + ~cf.InterpolationParameter.nc_set_variable + ~cf.InterpolationParameter.nc_set_variable_groups + ~cf.InterpolationParameter.nc_variable_groups + ~cf.InterpolationParameter.ndim + ~cf.InterpolationParameter.override_calendar + ~cf.InterpolationParameter.override_units + ~cf.InterpolationParameter.pad_missing + ~cf.InterpolationParameter.period + ~cf.InterpolationParameter.persist + ~cf.InterpolationParameter.properties + ~cf.InterpolationParameter.range + ~cf.InterpolationParameter.rechunk + ~cf.InterpolationParameter.reference_datetime + ~cf.InterpolationParameter.remove_data + ~cf.InterpolationParameter.replace_directory + ~cf.InterpolationParameter.rint + ~cf.InterpolationParameter.roll + ~cf.InterpolationParameter.round + ~cf.InterpolationParameter.sample_size + ~cf.InterpolationParameter.scale_factor + ~cf.InterpolationParameter.sd + ~cf.InterpolationParameter.second + ~cf.InterpolationParameter.select + ~cf.InterpolationParameter.set_data + ~cf.InterpolationParameter.set_properties + ~cf.InterpolationParameter.set_property + ~cf.InterpolationParameter.setprop + ~cf.InterpolationParameter.shape + ~cf.InterpolationParameter.sin + ~cf.InterpolationParameter.sinh + ~cf.InterpolationParameter.size + ~cf.InterpolationParameter.squeeze + ~cf.InterpolationParameter.standard_deviation + ~cf.InterpolationParameter.standard_name + ~cf.InterpolationParameter.subspace + ~cf.InterpolationParameter.sum + ~cf.InterpolationParameter.swapaxes + ~cf.InterpolationParameter.tan + ~cf.InterpolationParameter.tanh + ~cf.InterpolationParameter.to_dask_array + ~cf.InterpolationParameter.to_memory + ~cf.InterpolationParameter.to_units + ~cf.InterpolationParameter.transpose + ~cf.InterpolationParameter.trunc + ~cf.InterpolationParameter.uncompress + ~cf.InterpolationParameter.unique + ~cf.InterpolationParameter.units + ~cf.InterpolationParameter.unsafe_array + ~cf.InterpolationParameter.valid_max + ~cf.InterpolationParameter.valid_min + ~cf.InterpolationParameter.valid_range + ~cf.InterpolationParameter.var + ~cf.InterpolationParameter.variance + ~cf.InterpolationParameter.varray + ~cf.InterpolationParameter.where + ~cf.InterpolationParameter.year diff --git a/docs/source/class/cf.NodeCountProperties.rst b/docs/source/class/cf.NodeCountProperties.rst index b2147073d8..8bd07803ac 100644 --- a/docs/source/class/cf.NodeCountProperties.rst +++ b/docs/source/class/cf.NodeCountProperties.rst @@ -1,7 +1,7 @@ .. currentmodule:: cf .. default-role:: obj -.. _domainlist: +.. _nodecountproperties: cf.NodeCountProperties ====================== @@ -11,3 +11,59 @@ cf.NodeCountProperties .. autoclass:: cf.NodeCountProperties :no-members: :no-inherited-members: + +Methods +------- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.NodeCountProperties.calendar + ~cf.NodeCountProperties.clear_properties + ~cf.NodeCountProperties.comment + ~cf.NodeCountProperties.copy + ~cf.NodeCountProperties.creation_commands + ~cf.NodeCountProperties.del_properties + ~cf.NodeCountProperties.del_property + ~cf.NodeCountProperties.delprop + ~cf.NodeCountProperties.dump + ~cf.NodeCountProperties.equals + ~cf.NodeCountProperties.get_original_filenames + ~cf.NodeCountProperties.get_property + ~cf.NodeCountProperties.getprop + ~cf.NodeCountProperties.has_bounds + ~cf.NodeCountProperties.has_data + ~cf.NodeCountProperties.has_property + ~cf.NodeCountProperties.hasprop + ~cf.NodeCountProperties.history + ~cf.NodeCountProperties.id + ~cf.NodeCountProperties.identities + ~cf.NodeCountProperties.identity + ~cf.NodeCountProperties.leap_month + ~cf.NodeCountProperties.leap_year + ~cf.NodeCountProperties.long_name + ~cf.NodeCountProperties.match + ~cf.NodeCountProperties.match_by_identity + ~cf.NodeCountProperties.match_by_ncvar + ~cf.NodeCountProperties.match_by_property + ~cf.NodeCountProperties.month_lengths + ~cf.NodeCountProperties.nc_clear_variable_groups + ~cf.NodeCountProperties.nc_del_variable + ~cf.NodeCountProperties.nc_get_variable + ~cf.NodeCountProperties.nc_has_variable + ~cf.NodeCountProperties.nc_set_variable + ~cf.NodeCountProperties.nc_set_variable_groups + ~cf.NodeCountProperties.nc_variable_groups + ~cf.NodeCountProperties.properties + ~cf.NodeCountProperties.set_properties + ~cf.NodeCountProperties.set_property + ~cf.NodeCountProperties.setprop + ~cf.NodeCountProperties.standard_name + ~cf.NodeCountProperties.units + ~cf.NodeCountProperties.valid_max + ~cf.NodeCountProperties.valid_min + ~cf.NodeCountProperties.valid_range From ddd8d231cb3a293590f5d4380b11a66a5c6bb400 Mon Sep 17 00:00:00 2001 From: "Sadie L. Bartholomew" Date: Fri, 17 Jul 2026 17:43:46 +0100 Subject: [PATCH 11/13] Add 4 missing files as new API ref. class stubs w/ methods populated --- docs/source/class/cf.AggregatedArray.rst | 58 ++++++ docs/source/class/cf.CFImplementation.rst | 218 ++++++++++++++++++++++ docs/source/class/cf.ConstructList.rst | 39 ++++ docs/source/class/cf.Coordinate.rst | 34 ++++ 4 files changed, 349 insertions(+) create mode 100644 docs/source/class/cf.AggregatedArray.rst create mode 100644 docs/source/class/cf.CFImplementation.rst create mode 100644 docs/source/class/cf.ConstructList.rst create mode 100644 docs/source/class/cf.Coordinate.rst diff --git a/docs/source/class/cf.AggregatedArray.rst b/docs/source/class/cf.AggregatedArray.rst new file mode 100644 index 0000000000..75d8030441 --- /dev/null +++ b/docs/source/class/cf.AggregatedArray.rst @@ -0,0 +1,58 @@ +.. currentmodule:: cf +.. default-role:: obj + +.. _aggregatedarray: + +cf.AggregatedArray +================== + +---- + +.. autoclass:: cf.AggregatedArray + :no-members: + :no-inherited-members: + +Methods +------- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.AggregatedArray.Units + ~cf.AggregatedArray.array + ~cf.AggregatedArray.astype + ~cf.AggregatedArray.close + ~cf.AggregatedArray.copy + ~cf.AggregatedArray.dtype + ~cf.AggregatedArray.file_directory + ~cf.AggregatedArray.get_address + ~cf.AggregatedArray.get_attributes + ~cf.AggregatedArray.get_calendar + ~cf.AggregatedArray.get_compression_type + ~cf.AggregatedArray.get_filename + ~cf.AggregatedArray.get_fragment_array + ~cf.AggregatedArray.get_fragment_array_shape + ~cf.AggregatedArray.get_fragment_type + ~cf.AggregatedArray.get_fragmented_dimensions + ~cf.AggregatedArray.get_mask + ~cf.AggregatedArray.get_missing_values + ~cf.AggregatedArray.get_storage_options + ~cf.AggregatedArray.get_storage_protocol + ~cf.AggregatedArray.get_units + ~cf.AggregatedArray.get_unpack + ~cf.AggregatedArray.get_variable + ~cf.AggregatedArray.has_remote_storage_protocol + ~cf.AggregatedArray.ndim + ~cf.AggregatedArray.open + ~cf.AggregatedArray.replace_directory + ~cf.AggregatedArray.replace_filename + ~cf.AggregatedArray.shape + ~cf.AggregatedArray.size + ~cf.AggregatedArray.subarray_shapes + ~cf.AggregatedArray.subarrays + ~cf.AggregatedArray.to_dask_array + ~cf.AggregatedArray.to_memory diff --git a/docs/source/class/cf.CFImplementation.rst b/docs/source/class/cf.CFImplementation.rst new file mode 100644 index 0000000000..8f7993a4da --- /dev/null +++ b/docs/source/class/cf.CFImplementation.rst @@ -0,0 +1,218 @@ +.. currentmodule:: cf +.. default-role:: obj + +.. _cfimplementation: + +cf.CFImplementation +=================== + +---- + +.. autoclass:: cf.CFImplementation + :no-members: + :no-inherited-members: + +Methods +------- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.CFImplementation.bounds_insert_dimension + ~cf.CFImplementation.classes + ~cf.CFImplementation.climatological_time_axes + ~cf.CFImplementation.conform_geometry_variables + ~cf.CFImplementation.construct_insert_dimension + ~cf.CFImplementation.convert + ~cf.CFImplementation.copy + ~cf.CFImplementation.copy_construct + ~cf.CFImplementation.data_insert_dimension + ~cf.CFImplementation.del_parameter + ~cf.CFImplementation.del_properties + ~cf.CFImplementation.del_property + ~cf.CFImplementation.equal_components + ~cf.CFImplementation.equal_constructs + ~cf.CFImplementation.equal_datums + ~cf.CFImplementation.equal_properties + ~cf.CFImplementation.field_insert_dimension + ~cf.CFImplementation.get_array + ~cf.CFImplementation.get_auxiliary_coordinates + ~cf.CFImplementation.get_bounds + ~cf.CFImplementation.get_bounds_ncvar + ~cf.CFImplementation.get_cell_connectivities + ~cf.CFImplementation.get_cell_measures + ~cf.CFImplementation.get_cell_method_axes + ~cf.CFImplementation.get_cell_method_qualifiers + ~cf.CFImplementation.get_cell_method_string + ~cf.CFImplementation.get_cell_methods + ~cf.CFImplementation.get_cf_version + ~cf.CFImplementation.get_class + ~cf.CFImplementation.get_compressed_array + ~cf.CFImplementation.get_compressed_axes + ~cf.CFImplementation.get_compression_type + ~cf.CFImplementation.get_construct_data_axes + ~cf.CFImplementation.get_construct_data_size + ~cf.CFImplementation.get_construct_type + ~cf.CFImplementation.get_constructs + ~cf.CFImplementation.get_coordinate_conversion_parameters + ~cf.CFImplementation.get_coordinate_reference_coordinates + ~cf.CFImplementation.get_coordinate_references + ~cf.CFImplementation.get_coordinates + ~cf.CFImplementation.get_count + ~cf.CFImplementation.get_data + ~cf.CFImplementation.get_data_axes + ~cf.CFImplementation.get_data_calendar + ~cf.CFImplementation.get_data_compressed_axes + ~cf.CFImplementation.get_data_max + ~cf.CFImplementation.get_data_maximum + ~cf.CFImplementation.get_data_ndim + ~cf.CFImplementation.get_data_shape + ~cf.CFImplementation.get_data_size + ~cf.CFImplementation.get_data_source + ~cf.CFImplementation.get_data_sum + ~cf.CFImplementation.get_data_units + ~cf.CFImplementation.get_datum + ~cf.CFImplementation.get_datum_parameters + ~cf.CFImplementation.get_dimension_coordinates + ~cf.CFImplementation.get_domain_ancillaries + ~cf.CFImplementation.get_domain_axes + ~cf.CFImplementation.get_domain_axis_size + ~cf.CFImplementation.get_domain_topologies + ~cf.CFImplementation.get_field_ancillaries + ~cf.CFImplementation.get_field_data_axes + ~cf.CFImplementation.get_filenames + ~cf.CFImplementation.get_geometry + ~cf.CFImplementation.get_index + ~cf.CFImplementation.get_inherited_properties + ~cf.CFImplementation.get_interior_ring + ~cf.CFImplementation.get_interpolation_name + ~cf.CFImplementation.get_list + ~cf.CFImplementation.get_measure + ~cf.CFImplementation.get_node_count + ~cf.CFImplementation.get_original_filenames + ~cf.CFImplementation.get_parameter + ~cf.CFImplementation.get_part_node_count + ~cf.CFImplementation.get_properties + ~cf.CFImplementation.get_property + ~cf.CFImplementation.get_quantization + ~cf.CFImplementation.get_quantize_on_write + ~cf.CFImplementation.get_sample_dimension_position + ~cf.CFImplementation.get_tie_points + ~cf.CFImplementation.has_bounds + ~cf.CFImplementation.has_datum + ~cf.CFImplementation.has_domain_topology + ~cf.CFImplementation.has_property + ~cf.CFImplementation.initialise_AggregatedArray + ~cf.CFImplementation.initialise_AuxiliaryCoordinate + ~cf.CFImplementation.initialise_Bounds + ~cf.CFImplementation.initialise_BoundsFromNodesArray + ~cf.CFImplementation.initialise_CellConnectivity + ~cf.CFImplementation.initialise_CellConnectivityArray + ~cf.CFImplementation.initialise_CellMeasure + ~cf.CFImplementation.initialise_CellMethod + ~cf.CFImplementation.initialise_CoordinateConversion + ~cf.CFImplementation.initialise_CoordinateReference + ~cf.CFImplementation.initialise_Count + ~cf.CFImplementation.initialise_Data + ~cf.CFImplementation.initialise_Datum + ~cf.CFImplementation.initialise_DimensionCoordinate + ~cf.CFImplementation.initialise_DimensionCoordinate_from_AuxiliaryCoordinate + ~cf.CFImplementation.initialise_Domain + ~cf.CFImplementation.initialise_DomainAncillary + ~cf.CFImplementation.initialise_DomainAxis + ~cf.CFImplementation.initialise_DomainTopology + ~cf.CFImplementation.initialise_Field + ~cf.CFImplementation.initialise_FieldAncillary + ~cf.CFImplementation.initialise_GatheredArray + ~cf.CFImplementation.initialise_H5netcdfArray + ~cf.CFImplementation.initialise_Index + ~cf.CFImplementation.initialise_InteriorRing + ~cf.CFImplementation.initialise_InterpolationParameter + ~cf.CFImplementation.initialise_List + ~cf.CFImplementation.initialise_NetCDF4Array + ~cf.CFImplementation.initialise_NodeCountProperties + ~cf.CFImplementation.initialise_PartNodeCount + ~cf.CFImplementation.initialise_PointTopologyArray + ~cf.CFImplementation.initialise_PyfiveArray + ~cf.CFImplementation.initialise_Quantization + ~cf.CFImplementation.initialise_RaggedContiguousArray + ~cf.CFImplementation.initialise_RaggedIndexedArray + ~cf.CFImplementation.initialise_RaggedIndexedContiguousArray + ~cf.CFImplementation.initialise_ScipyNetcdfFileArray + ~cf.CFImplementation.initialise_SubsampledArray + ~cf.CFImplementation.initialise_TiePointIndex + ~cf.CFImplementation.initialise_ZarrArray + ~cf.CFImplementation.is_climatology + ~cf.CFImplementation.is_domain + ~cf.CFImplementation.is_field + ~cf.CFImplementation.is_geometry + ~cf.CFImplementation.is_masked + ~cf.CFImplementation.nc_get_dataset_chunksizes + ~cf.CFImplementation.nc_get_dataset_shards + ~cf.CFImplementation.nc_get_datum_variable + ~cf.CFImplementation.nc_get_dimension + ~cf.CFImplementation.nc_get_external + ~cf.CFImplementation.nc_get_geometry_variable + ~cf.CFImplementation.nc_get_global_attributes + ~cf.CFImplementation.nc_get_group_attributes + ~cf.CFImplementation.nc_get_hdf5_chunksizes + ~cf.CFImplementation.nc_get_sample_dimension + ~cf.CFImplementation.nc_get_variable + ~cf.CFImplementation.nc_get_variable_groups + ~cf.CFImplementation.nc_is_unlimited_axis + ~cf.CFImplementation.nc_set_dataset_chunksizes + ~cf.CFImplementation.nc_set_dataset_shards + ~cf.CFImplementation.nc_set_datum_variable + ~cf.CFImplementation.nc_set_dimension + ~cf.CFImplementation.nc_set_external + ~cf.CFImplementation.nc_set_geometry_variable + ~cf.CFImplementation.nc_set_global_attributes + ~cf.CFImplementation.nc_set_group_attributes + ~cf.CFImplementation.nc_set_hdf5_chunksizes + ~cf.CFImplementation.nc_set_instance_dimension + ~cf.CFImplementation.nc_set_interpolation_subarea_dimension + ~cf.CFImplementation.nc_set_node_coordinate_variable + ~cf.CFImplementation.nc_set_sample_dimension + ~cf.CFImplementation.nc_set_subsampled_dimension + ~cf.CFImplementation.nc_set_unlimited_axis + ~cf.CFImplementation.nc_set_variable + ~cf.CFImplementation.parameters + ~cf.CFImplementation.set_auxiliary_coordinate + ~cf.CFImplementation.set_bounds + ~cf.CFImplementation.set_cell_connectivity + ~cf.CFImplementation.set_cell_measure + ~cf.CFImplementation.set_cell_method + ~cf.CFImplementation.set_cell_method_axes + ~cf.CFImplementation.set_cell_method_method + ~cf.CFImplementation.set_class + ~cf.CFImplementation.set_climatology + ~cf.CFImplementation.set_construct + ~cf.CFImplementation.set_coordinate_conversion + ~cf.CFImplementation.set_coordinate_reference + ~cf.CFImplementation.set_coordinate_reference_coordinate + ~cf.CFImplementation.set_coordinate_reference_coordinates + ~cf.CFImplementation.set_data + ~cf.CFImplementation.set_dataset_compliance + ~cf.CFImplementation.set_datum + ~cf.CFImplementation.set_dependent_tie_points + ~cf.CFImplementation.set_dimension_coordinate + ~cf.CFImplementation.set_domain_ancillary + ~cf.CFImplementation.set_domain_axis + ~cf.CFImplementation.set_domain_topology + ~cf.CFImplementation.set_field_ancillary + ~cf.CFImplementation.set_geometry + ~cf.CFImplementation.set_inherited_properties + ~cf.CFImplementation.set_interior_ring + ~cf.CFImplementation.set_interpolation + ~cf.CFImplementation.set_node_count_properties + ~cf.CFImplementation.set_original_filenames + ~cf.CFImplementation.set_parameter + ~cf.CFImplementation.set_part_node_count_properties + ~cf.CFImplementation.set_properties + ~cf.CFImplementation.set_quantization + ~cf.CFImplementation.squeeze + ~cf.CFImplementation.unsqueeze diff --git a/docs/source/class/cf.ConstructList.rst b/docs/source/class/cf.ConstructList.rst new file mode 100644 index 0000000000..b37563a147 --- /dev/null +++ b/docs/source/class/cf.ConstructList.rst @@ -0,0 +1,39 @@ +.. currentmodule:: cf +.. default-role:: obj + +.. _interiorring: + +cf.ConstructList +================ + +---- + +.. autoclass:: cf.ConstructList + :no-members: + :no-inherited-members: + +Methods +------- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.ConstructList.append + ~cf.ConstructList.clear + ~cf.ConstructList.close + ~cf.ConstructList.copy + ~cf.ConstructList.count + ~cf.ConstructList.equals + ~cf.ConstructList.extend + ~cf.ConstructList.index + ~cf.ConstructList.insert + ~cf.ConstructList.pop + ~cf.ConstructList.remove + ~cf.ConstructList.reverse + ~cf.ConstructList.select + ~cf.ConstructList.select_by_identity + ~cf.ConstructList.sort diff --git a/docs/source/class/cf.Coordinate.rst b/docs/source/class/cf.Coordinate.rst new file mode 100644 index 0000000000..39a074b885 --- /dev/null +++ b/docs/source/class/cf.Coordinate.rst @@ -0,0 +1,34 @@ +.. currentmodule:: cf +.. default-role:: obj + +.. _interiorring: + +cf.InteriorRing +=============== + +---- + +.. autoclass:: cf.InteriorRing + :no-members: + :no-inherited-members: + +Methods +------- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.Coordinate.T + ~cf.Coordinate.X + ~cf.Coordinate.Y + ~cf.Coordinate.Z + ~cf.Coordinate.autoperiod + ~cf.Coordinate.axis + ~cf.Coordinate.ctype + ~cf.Coordinate.identities + ~cf.Coordinate.identity + ~cf.Coordinate.positive From 5d5f6f7a6bfbf9bce860e75b956a015d1f17e823 Mon Sep 17 00:00:00 2001 From: "Sadie L. Bartholomew" Date: Fri, 24 Jul 2026 16:28:34 +0100 Subject: [PATCH 12/13] Fix docs issue whereby cf.Domain was autodoc'd as cfdm.Domain --- docs/source/class/cf.Domain.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/class/cf.Domain.rst b/docs/source/class/cf.Domain.rst index bcdd1a7ef7..961485d79a 100644 --- a/docs/source/class/cf.Domain.rst +++ b/docs/source/class/cf.Domain.rst @@ -8,7 +8,7 @@ cf.Domain ---- -.. autoclass:: cfdm.Domain +.. autoclass:: cf.Domain :no-members: :no-inherited-members: From 11f111b134f8b57cb3ca6bb71c9eb57e10bf1d22 Mon Sep 17 00:00:00 2001 From: "Sadie L. Bartholomew" Date: Fri, 24 Jul 2026 18:29:53 +0100 Subject: [PATCH 13/13] Correct indentation in Field class stub file list entry --- docs/source/class/cf.Field.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/class/cf.Field.rst b/docs/source/class/cf.Field.rst index 375208deda..13d9abd52c 100644 --- a/docs/source/class/cf.Field.rst +++ b/docs/source/class/cf.Field.rst @@ -171,7 +171,7 @@ Data ~cf.Field.shape ~cf.Field.size ~cf.Field.to_dask_array - ~cf.Field.varray + ~cf.Field.varray .. rubric:: *Rearranging elements*