From ef0f842aed6d851b38ff37b52cee15435fe9cf71 Mon Sep 17 00:00:00 2001 From: Trevor James Smith <10819524+Zeitsperre@users.noreply.github.com> Date: Tue, 1 Oct 2024 16:53:36 -0400 Subject: [PATCH] fix documentation build failures, remove obsolete imports --- .readthedocs.yml | 2 +- docs/source/conf.py | 60 +++++++++++++------------- docs/source/processes.rst | 14 +++++- rook/__init__.py | 8 +++- rook/dashboard/plots/activity.py | 2 +- rook/processes/wps_average_dim.py | 3 -- rook/processes/wps_average_shape.py | 2 - rook/processes/wps_average_time.py | 2 - rook/processes/wps_average_weighted.py | 4 -- rook/processes/wps_concat.py | 3 -- 10 files changed, 52 insertions(+), 48 deletions(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index a6a210c1..99cb8827 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -10,7 +10,7 @@ sphinx: configuration: docs/source/conf.py # fail_on_warning might generate hard to fix error, in this case it can be # disabled but this also means those errors will fail silently, choose wisely. - fail_on_warning: false + fail_on_warning: true # Optionally build your docs in additional formats such as PDF and ePub formats: all diff --git a/docs/source/conf.py b/docs/source/conf.py index 2874aa06..148142b5 100755 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -48,45 +48,47 @@ # List of all tested working mock imports from all birds so new birds can # inherit without having to test which work which do not. autodoc_mock_imports = [ - "numpy", - "xarray", + "affine", + "bottleneck", + "cairo", + "cartopy", + "cftime", + "dask", "fiona", - "rasterio", - "shapely", - "osgeo", + "gdal", "geopandas", + "geos", + "geotiff", + "hdf4", + "hdf5", + "matplotlib", + "netCDF4", + "networkx", + "numba", + "numpy", + "ocgis", + "osgeo", "pandas", - "statsmodels", - "affine", + "parse", + "proj", + "pyproj", + "rasterio", "rasterstats", - "spotpy", - "matplotlib", + "scikit-learn", "scipy", - "unidecode", - "gdal", "sentry_sdk", - "dask", - "numba", - "parse", + "shapely", "siphon", "sklearn", - "cftime", - "netCDF4", - "bottleneck", - "ocgis", - "geotiff", - "geos", - "hdf4", - "hdf5", + "spotpy", + "statsmodels", + "unidecode", + "xarray", "zlib", - "pyproj", - "proj", - "cartopy", - "scikit-learn", - "cairo", - "networkx", - "roocs_utils", + # roocs + "clisops" "daops", + "roocs_utils", ] # Monkeypatch constant because the following are mock imports. diff --git a/docs/source/processes.rst b/docs/source/processes.rst index 72a162a3..1b616592 100644 --- a/docs/source/processes.rst +++ b/docs/source/processes.rst @@ -17,7 +17,19 @@ Subset Average ------- -.. autoprocess:: rook.processes.wps_average.Average +.. autoprocess:: rook.processes.wps_average_dim.AverageByDimension + :docstring: + :skiplines: 1 + +.. autoprocess:: rook.processes.wps_average_shape.AverageByShape + :docstring: + :skiplines: 1 + +.. autoprocess:: rook.processes.wps_average_time.AverageByTime + :docstring: + :skiplines: 1 + +.. autoprocess:: rook.processes.wps_average_weighted.WeightedAverage :docstring: :skiplines: 1 diff --git a/rook/__init__.py b/rook/__init__.py index c252c9fb..d8a3b499 100644 --- a/rook/__init__.py +++ b/rook/__init__.py @@ -3,8 +3,12 @@ from roocs_utils.config import get_config -import rook +# Workaround for roocs_utils to not re-import rook +class Package: + __file__ = __file__ # noqa -CONFIG = get_config(rook) + +package = Package() +CONFIG = get_config(package) from .wsgi import application # noqa: F401 diff --git a/rook/dashboard/plots/activity.py b/rook/dashboard/plots/activity.py index 1f69d1c7..6c92d85f 100644 --- a/rook/dashboard/plots/activity.py +++ b/rook/dashboard/plots/activity.py @@ -25,7 +25,7 @@ def plot(self): toolbar_location=None, x_axis_type="datetime", sizing_mode="scale_width", - plot_height=100, + height=100, ) status = ["success", "failed"] colors = ["green", "red"] diff --git a/rook/processes/wps_average_dim.py b/rook/processes/wps_average_dim.py index 275bd400..9e641a1e 100644 --- a/rook/processes/wps_average_dim.py +++ b/rook/processes/wps_average_dim.py @@ -3,8 +3,6 @@ from pywps import FORMATS, ComplexOutput, Format, LiteralInput, Process from pywps.app.Common import Metadata -from pywps.app.exceptions import ProcessError -from pywps.inout.outputs import MetaFile, MetaLink4 from ..director import wrap_director from ..utils.input_utils import parse_wps_input @@ -122,7 +120,6 @@ def _handler(self, request, response): request.inputs, "dims", as_sequence=True, default=None ), } - # print(inputs) # Let the director manage the processing or redirection to original files director = wrap_director(collection, inputs, run_average_by_dim) diff --git a/rook/processes/wps_average_shape.py b/rook/processes/wps_average_shape.py index 76b50b71..ec63ada9 100644 --- a/rook/processes/wps_average_shape.py +++ b/rook/processes/wps_average_shape.py @@ -3,8 +3,6 @@ from pywps import FORMATS, ComplexOutput, Format, LiteralInput, Process, ComplexInput from pywps.app.Common import Metadata -from pywps.app.exceptions import ProcessError -from pywps.inout.outputs import MetaFile, MetaLink4 from ..director import wrap_director from ..utils.input_utils import parse_wps_input diff --git a/rook/processes/wps_average_time.py b/rook/processes/wps_average_time.py index 31aaef32..c3181330 100644 --- a/rook/processes/wps_average_time.py +++ b/rook/processes/wps_average_time.py @@ -3,8 +3,6 @@ from pywps import FORMATS, ComplexOutput, Format, LiteralInput, Process from pywps.app.Common import Metadata -from pywps.app.exceptions import ProcessError -from pywps.inout.outputs import MetaFile, MetaLink4 from ..director import wrap_director from ..utils.input_utils import parse_wps_input diff --git a/rook/processes/wps_average_weighted.py b/rook/processes/wps_average_weighted.py index ee34612b..bc32d405 100644 --- a/rook/processes/wps_average_weighted.py +++ b/rook/processes/wps_average_weighted.py @@ -1,10 +1,7 @@ import logging -import os from pywps import FORMATS, ComplexOutput, Format, LiteralInput, Process from pywps.app.Common import Metadata -from pywps.app.exceptions import ProcessError -from pywps.inout.outputs import MetaFile, MetaLink4 from ..director import wrap_director from ..utils.input_utils import parse_wps_input @@ -82,7 +79,6 @@ def _handler(self, request, response): "apply_fixes": False, "pre_checked": False, } - # print(inputs) # Let the director manage the processing or redirection to original files director = wrap_director(collection, inputs, run_weighted_average) diff --git a/rook/processes/wps_concat.py b/rook/processes/wps_concat.py index aa1d68cf..fc8962e6 100644 --- a/rook/processes/wps_concat.py +++ b/rook/processes/wps_concat.py @@ -3,9 +3,6 @@ from pywps import FORMATS, ComplexOutput, Format, LiteralInput, Process from pywps.app.Common import Metadata -# from pywps.app.exceptions import ProcessError -# from pywps.inout.outputs import MetaFile, MetaLink4 - from ..director import wrap_director from ..utils.input_utils import parse_wps_input from ..utils.metalink_utils import build_metalink