From c176c06b36d9e159783efd49f65dda62eacaca6a Mon Sep 17 00:00:00 2001 From: Bijal Patel Date: Wed, 13 Sep 2023 19:39:03 +0000 Subject: [PATCH] make cyrsoxs a mock import --- docs/requirements.txt | 1 - docs/source/conf.py | 10 +++++++++- 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index 90a25de..819e4e4 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -7,5 +7,4 @@ scipy pandas matplotlib scikit-image -cyrsoxs xarray \ No newline at end of file diff --git a/docs/source/conf.py b/docs/source/conf.py index a26bba0..6e5cc84 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -18,11 +18,16 @@ import os import sys + sys.path.insert(0, os.path.abspath("../../")) sys.path.insert(0, os.path.abspath("../NRSS/")) -extensions = ["sphinx.ext.autodoc", "sphinx.ext.napoleon", "sphinx_design"] # numpydoc and google docstrings +extensions = [ + "sphinx.ext.autodoc", + "sphinx.ext.napoleon", + "sphinx_design", +] # numpydoc and google docstrings # Add any paths that contain templates here, relative to this directory. templates_path = ["_templates"] @@ -68,3 +73,6 @@ # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ["_static"] + +# Autodoc params +autodoc_mock_imports = ["CyRSoXS"]