From df51c3d028aecd1a3f98017b8f33e391a78c713b Mon Sep 17 00:00:00 2001 From: Daniel Kohler <11864045+ddkohler@users.noreply.github.com> Date: Wed, 21 Feb 2024 13:29:23 -0600 Subject: [PATCH 1/8] troubleshoot render --- docs/cli.rst | 14 +++++++------- docs/conf.py | 2 +- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/cli.rst b/docs/cli.rst index 1b576ff15..a257796bf 100644 --- a/docs/cli.rst +++ b/docs/cli.rst @@ -5,13 +5,13 @@ Command Line Interface (CLI) Most of the CLI interface is new as of v3.5.2 and under active depelopment. The commands here may change. -Currently, there are two supported CLI calls to use: `wt-convert`, and `wt5`. -For usage hints, use the `--help` argument. +Currently, there are two supported CLI calls to use: ``wt-convert``, and ``wt5``. +For usage hints, use the ``--help`` argument. wt-convert ---------- -Use `wt-convert`` to explore the WrightTools units system and the conversions of units. +Use ``wt-convert`` to explore the WrightTools units system and the conversions of units. .. code-block:: shell > wt-units 1330 nm wn @@ -27,7 +27,7 @@ wt5 The wt5 command is meant to provide easy access to wt5 files and some basic wt5 properties. -Use `wt5 glob` to quickly probe a folder for wt5s contained inside +Use ``wt5 glob`` to quickly probe a folder for wt5s contained inside .. code-block:: shell > wt5 glob -d path/to/datasets @@ -35,7 +35,7 @@ Use `wt5 glob` to quickly probe a folder for wt5s contained inside WrightTools\datasets\wt5\v1.0.0\perovskite_TA.wt5 WrightTools\datasets\wt5\v1.0.1\MoS2_TrEE_movie.wt5 -Use `wt5 explore` to see details of wt5s within a folder, as the option of quick load a wt5. +Use ``wt5 explore`` to see details of wt5s within a folder, as the option of quick load a wt5. .. code-block:: shell > wt5 explore -d path/to/data/folders @@ -50,7 +50,7 @@ Use `wt5 explore` to see details of wt5s within a folder, as the option of quick Specify an index to load that entry. Use `t` to rerender table. Use no argument to exit. " -Use `wt5 load` to quickly open an interactive python console with your wt5 data pre-loaded. +Use ``wt5 load`` to quickly open an interactive python console with your wt5 data pre-loaded. .. code-block:: shell > wt5 load path\to\data_file.wt5 --- INTERACTING --- (to continue, call exit() or quit()) @@ -60,7 +60,7 @@ Use `wt5 load` to quickly open an interactive python console with your wt5 data >>> -Use `wt5 tree` to see a quick tree structure of a wt5 file. +Use ``wt5 tree`` to see a quick tree structure of a wt5 file. .. code-block:: shell > wt5 tree path\to\data diff --git a/docs/conf.py b/docs/conf.py index fb46ac262..f76fc1050 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -86,7 +86,7 @@ # General information about the project. project = "WrightTools" -copyright = "2016-2019, WrightTools Developers" +copyright = "2016-2024, WrightTools Developers" author = "WrightTools Developers" # The version info for the project you're documenting, acts as replacement for From 65b334618837d0d9f02f785a31b6217615588b59 Mon Sep 17 00:00:00 2001 From: Daniel Kohler <11864045+ddkohler@users.noreply.github.com> Date: Thu, 22 Feb 2024 10:17:33 -0600 Subject: [PATCH 2/8] Update conf.py --- docs/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index f76fc1050..fcf19d6da 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -240,10 +240,10 @@ def reset_wt(gallery_conf, fname): sphinx_gallery_conf = { - "examples_dirs": "../examples", + "examples_dirs": ".\examples", "filename_pattern": "/*.py", "gallery_dirs": "auto_examples", - "download_section_examples": False, + # "download_section_examples": False, "backreferences_dir": os.path.join("gen_modules", "backreferences"), "reset_modules": ["matplotlib", reset_wt], } From ea7f2c6c7eae2047a8e2dd050541fd11d51c9830 Mon Sep 17 00:00:00 2001 From: Daniel Kohler <11864045+ddkohler@users.noreply.github.com> Date: Thu, 22 Feb 2024 10:32:56 -0600 Subject: [PATCH 3/8] Update conf.py --- docs/conf.py | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index fcf19d6da..cf27d6702 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -20,14 +20,15 @@ import glob import os import sys -import sphinx_gallery +# import sphinx_gallery import math +import pathlib # --- define ------------------------------------------------------------------------------------- -here = os.path.abspath(os.path.dirname(__file__)) +here = pathlib.Path(__file__).resolve().parent with open(os.path.join(os.path.dirname(here), "WrightTools", "VERSION")) as version_file: version = version_file.read().strip() @@ -38,7 +39,7 @@ # documentation root, use os.path.abspath to make it absolute, like shown here. sys.path.insert(0, os.path.abspath(".")) -sys.path.insert(0, os.path.abspath("../WrightTools")) +sys.path.insert(0, here.parent / "WrightTools") # --- general configuration ---------------------------------------------------------------------- @@ -240,7 +241,7 @@ def reset_wt(gallery_conf, fname): sphinx_gallery_conf = { - "examples_dirs": ".\examples", + "examples_dirs": here.parent / "examples", "filename_pattern": "/*.py", "gallery_dirs": "auto_examples", # "download_section_examples": False, From 213dd837cc0b4aa2c4aed172febdad1cb8c9dd9e Mon Sep 17 00:00:00 2001 From: Daniel Kohler <11864045+ddkohler@users.noreply.github.com> Date: Thu, 22 Feb 2024 11:42:33 -0600 Subject: [PATCH 4/8] Update cli.rst --- docs/cli.rst | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/docs/cli.rst b/docs/cli.rst index a257796bf..d3ece400d 100644 --- a/docs/cli.rst +++ b/docs/cli.rst @@ -39,7 +39,6 @@ Use ``wt5 explore`` to see details of wt5s within a folder, as the option of qui .. code-block:: shell > wt5 explore -d path/to/data/folders - " ┏━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━┓ ┃ ┃ path ┃ size (MB) ┃ created ┃ name ┃ shape ┃ axes ┃ variables ┃ channels ┃ ┡━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━┩ @@ -48,10 +47,10 @@ Use ``wt5 explore`` to see details of wt5s within a folder, as the option of qui │ 2 │ WrightTools\datasets\wt5\v1.0.1\MoS2_TrEE_movie.wt5 │ 2.3 │ 2018-06-11 16:41:47 │ _001_dat │ (41, 41, 23) │ ('w2', 'w1=wm', 'd2') │ 7 │ 6 │ └───┴─────────────────────────────────────────────────────┴───────────┴─────────────────────┴───────────────┴──────────────┴───────────────────────┴───────────┴──────────┘ Specify an index to load that entry. Use `t` to rerender table. Use no argument to exit. - " Use ``wt5 load`` to quickly open an interactive python console with your wt5 data pre-loaded. .. code-block:: shell + > wt5 load path\to\data_file.wt5 --- INTERACTING --- (to continue, call exit() or quit()) >>> import WrightTools as wt @@ -63,11 +62,10 @@ Use ``wt5 load`` to quickly open an interactive python console with your wt5 dat Use ``wt5 tree`` to see a quick tree structure of a wt5 file. .. code-block:: shell + > wt5 tree path\to\data - " / (...\felu75fe.wt5) (25, 256) ├── axes (2): w2 (wn), w2-wa (wn) ├── constants (0): └── channels (1): array_signal - " From e05b489da1462ed74bbb09766eb7fde53da8c63e Mon Sep 17 00:00:00 2001 From: Daniel Kohler <11864045+ddkohler@users.noreply.github.com> Date: Thu, 22 Feb 2024 12:50:56 -0600 Subject: [PATCH 5/8] Update cli.rst --- docs/cli.rst | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/cli.rst b/docs/cli.rst index d3ece400d..a88e8202d 100644 --- a/docs/cli.rst +++ b/docs/cli.rst @@ -27,7 +27,8 @@ wt5 The wt5 command is meant to provide easy access to wt5 files and some basic wt5 properties. -Use ``wt5 glob`` to quickly probe a folder for wt5s contained inside +Use ``wt5 glob`` to quickly probe a folder for wt5s contained inside. + .. code-block:: shell > wt5 glob -d path/to/datasets @@ -36,6 +37,7 @@ Use ``wt5 glob`` to quickly probe a folder for wt5s contained inside WrightTools\datasets\wt5\v1.0.1\MoS2_TrEE_movie.wt5 Use ``wt5 explore`` to see details of wt5s within a folder, as the option of quick load a wt5. + .. code-block:: shell > wt5 explore -d path/to/data/folders @@ -49,6 +51,7 @@ Use ``wt5 explore`` to see details of wt5s within a folder, as the option of qui Specify an index to load that entry. Use `t` to rerender table. Use no argument to exit. Use ``wt5 load`` to quickly open an interactive python console with your wt5 data pre-loaded. + .. code-block:: shell > wt5 load path\to\data_file.wt5 From a5969ca6d767bfb1713809d13b06513574b8d4af Mon Sep 17 00:00:00 2001 From: Daniel Kohler <11864045+ddkohler@users.noreply.github.com> Date: Thu, 22 Feb 2024 14:07:56 -0600 Subject: [PATCH 6/8] Update conf.py --- docs/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index cf27d6702..70aa40751 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -30,7 +30,7 @@ here = pathlib.Path(__file__).resolve().parent -with open(os.path.join(os.path.dirname(here), "WrightTools", "VERSION")) as version_file: +with open(here.parent / "WrightTools" / "VERSION") as version_file: version = version_file.read().strip() @@ -244,7 +244,7 @@ def reset_wt(gallery_conf, fname): "examples_dirs": here.parent / "examples", "filename_pattern": "/*.py", "gallery_dirs": "auto_examples", - # "download_section_examples": False, + "download_section_examples": False, "backreferences_dir": os.path.join("gen_modules", "backreferences"), "reset_modules": ["matplotlib", reset_wt], } From 45072a71c6c07472570b937ca979bbc780f2e9a0 Mon Sep 17 00:00:00 2001 From: Daniel Kohler <11864045+ddkohler@users.noreply.github.com> Date: Thu, 22 Feb 2024 14:13:45 -0600 Subject: [PATCH 7/8] Update conf.py --- docs/conf.py | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 70aa40751..50c9289f8 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -244,7 +244,6 @@ def reset_wt(gallery_conf, fname): "examples_dirs": here.parent / "examples", "filename_pattern": "/*.py", "gallery_dirs": "auto_examples", - "download_section_examples": False, "backreferences_dir": os.path.join("gen_modules", "backreferences"), "reset_modules": ["matplotlib", reset_wt], } From 594db634b624127ae75fad6d856467589eb0de63 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Thu, 22 Feb 2024 20:22:09 +0000 Subject: [PATCH 8/8] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- docs/conf.py | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/conf.py b/docs/conf.py index 50c9289f8..eb57526a0 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -20,6 +20,7 @@ import glob import os import sys + # import sphinx_gallery import math import pathlib