From 4e6c4b6a696b8167942fb492c070164a270d3bd7 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Thu, 1 Aug 2024 14:44:18 +0000 Subject: [PATCH 1/2] Update pydata-sphinx-theme requirement Updates the requirements on [pydata-sphinx-theme](https://github.com/pydata/pydata-sphinx-theme) to permit the latest version. - [Release notes](https://github.com/pydata/pydata-sphinx-theme/releases) - [Changelog](https://github.com/pydata/pydata-sphinx-theme/blob/main/RELEASE.md) - [Commits](https://github.com/pydata/pydata-sphinx-theme/compare/v0.13.1...v0.15.4) --- updated-dependencies: - dependency-name: pydata-sphinx-theme dependency-type: direct:production ... Signed-off-by: dependabot[bot] --- docs/requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index e3256989..db50465d 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,4 +1,4 @@ sphinx>=3.0.0,!=6.1.2 -pydata-sphinx-theme>=0.13.1,<0.14 +pydata-sphinx-theme>=0.13.1,<0.16 numpydoc>=1.4.0 sphinx-copybutton>=0.5.0 From 983fbdc438ae5ae01db010857a71d4ec491f9aab Mon Sep 17 00:00:00 2001 From: Daniel Weston Date: Tue, 6 Aug 2024 16:58:23 +0100 Subject: [PATCH 2/2] fix paths --- docs/{source => }/conf.py | 14 ++++++++------ docs/source/tutorials/index.rst | 2 +- 2 files changed, 9 insertions(+), 7 deletions(-) rename docs/{source => }/conf.py (96%) diff --git a/docs/source/conf.py b/docs/conf.py similarity index 96% rename from docs/source/conf.py rename to docs/conf.py index d784326e..096e90cf 100644 --- a/docs/source/conf.py +++ b/docs/conf.py @@ -35,7 +35,7 @@ import sys _HERE = os.path.dirname(__file__) -_ROOT_DIR = os.path.abspath(os.path.join(_HERE, "../..")) +_ROOT_DIR = os.path.abspath(os.path.join(_HERE, "../")) _PACKAGE_DIR = os.path.abspath(os.path.join(_HERE, "up4")) _SUBPACKAGE_DIR = os.path.abspath(os.path.join(_HERE, "up4/plotting")) sys.path.insert(0, _ROOT_DIR) @@ -50,7 +50,7 @@ # The full version, including alpha/beta/rc tags # Load the package's __version__.py module as a dictionary. about = {} -with open("../../up4/__version__.py") as f: +with open("../up4/__version__.py") as f: exec(f.read(), about) release = about["__version__"] @@ -91,7 +91,7 @@ # source_encoding = 'utf-8-sig' # The root toctree document -master_doc = "index" # NOTE: will be changed to `root_doc` in sphinx 4 +master_doc = "source/index" # NOTE: will be changed to `root_doc` in sphinx 4 autosummary_generate = True @@ -177,7 +177,7 @@ # a list of builtin themes. html_theme = "pydata_sphinx_theme" -html_logo = "_static/logo.jpeg" +html_logo = "source/_static/logo.jpeg" version_match = version if "dev" in version else "v" + version @@ -205,7 +205,9 @@ # "icon": "fas fa-arrow-circle-down", # }, # ], - "switcher": dict(json_url="./_static/version.json", version_match=version_match), + "switcher": dict( + json_url="./source/_static/version.json", version_match=version_match + ), } html_context = { @@ -227,7 +229,7 @@ # Add any paths that contain custom static files (such as style sheets) here, # 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"] +html_static_path = ["./source/_static"] # Add any extra paths that contain custom files (such as robots.txt or # .htaccess) here, relative to this directory. These files are copied diff --git a/docs/source/tutorials/index.rst b/docs/source/tutorials/index.rst index 96d9e27c..44a8f64d 100644 --- a/docs/source/tutorials/index.rst +++ b/docs/source/tutorials/index.rst @@ -6,7 +6,7 @@ to more in-depth processing techniques. .. toctree:: :maxdepth: 1 - :caption: Getting Sarted + :caption: Getting Started basic_tutorial