Skip to content

Commit

Permalink
fix documentation build failures, remove obsolete imports
Browse files Browse the repository at this point in the history
  • Loading branch information
Zeitsperre committed Oct 1, 2024
1 parent 215e282 commit ef0f842
Show file tree
Hide file tree
Showing 10 changed files with 52 additions and 48 deletions.
2 changes: 1 addition & 1 deletion .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
60 changes: 31 additions & 29 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
14 changes: 13 additions & 1 deletion docs/source/processes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
8 changes: 6 additions & 2 deletions rook/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion rook/dashboard/plots/activity.py
Original file line number Diff line number Diff line change
Expand Up @@ -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"]
Expand Down
3 changes: 0 additions & 3 deletions rook/processes/wps_average_dim.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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)
Expand Down
2 changes: 0 additions & 2 deletions rook/processes/wps_average_shape.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 0 additions & 2 deletions rook/processes/wps_average_time.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 0 additions & 4 deletions rook/processes/wps_average_weighted.py
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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)
Expand Down
3 changes: 0 additions & 3 deletions rook/processes/wps_concat.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit ef0f842

Please sign in to comment.