Merge pull request #792 from nsidc/promote-troubleshooting-doc

Move troubleshooting page and redirect with sphinx extension

doc/conf.py

@@ -47,6 +47,7 @@
     "sphinx_selective_exclude.eager_only",
     "sphinx_selective_exclude.search_auto_exclude",
     "sphinx_selective_exclude.modindex_exclude",
+    "sphinxext.rediraffe",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -72,6 +73,13 @@
 }
 
 
+# -- Redirection options ------------------------------------------
+
+rediraffe_redirects = {
+    "user/how-to/troubleshooting.md": "user/troubleshooting.md",
+}
+
+
 # -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for

doc/environment.yml

@@ -11,6 +11,7 @@ dependencies:
   - myst-parser ~=2.0.0
   - sphinx-click ~=3.0.1
   - sphinx-rtd-theme ~=1.2.2
+  - sphinxext-rediraffe ~=0.2.7
   - autodoc-pydantic ~=1.9.0
   - pydantic <2.0.0a0
 

doc/index.rst

@@ -29,6 +29,7 @@ QGreenland Documentation
     :caption: User Documentation
     :hidden:
 
+    user/troubleshooting
     user/tutorials/index
     user/how-to/index
     user/reference/index

doc/user/how-to/troubleshooting.md → doc/user/troubleshooting.md

@@ -1,10 +1,19 @@
 # Troubleshooting
 
+
 ```{contents} Contents
 :local:
 
 ```
 
+```{admonition} Get more help
+:class: info
+
+This page is a compilation of some common pitfalls and issues users have encountered. If
+your problem isn't documented here, please join us on [GitHub
+Discussions](https://github.com/nsidc/qgreenland/discussions/) to get more help!
+```
+
 
 ## Difficulty opening the project
 

environments/main/conda-lock.yml

@@ -13,7 +13,7 @@
 version: 1
 metadata:
   content_hash:
-    linux-64: e1e65448a6dad08f3e0097709a9b983ee7f0845bef340fa1ebfad757e085f0fe
+    linux-64: 6ce29b7240c6933499a1107672ba0fb2fea457cc7de78d6b4b8df845762bb8de
   channels:
   - url: conda-forge
     used_env_vars: []
@@ -443,16 +443,16 @@ package:
   category: main
   optional: false
 - name: laz-perf
-  version: 3.3.0
+  version: 3.4.0
   manager: conda
   platform: linux-64
   dependencies:
     libgcc-ng: '>=12'
     libstdcxx-ng: '>=12'
-  url: https://conda.anaconda.org/conda-forge/linux-64/laz-perf-3.3.0-hf52228f_0.conda
+  url: https://conda.anaconda.org/conda-forge/linux-64/laz-perf-3.4.0-h00ab1b0_0.conda
   hash:
-    md5: 07e6dff0011a4fa2a8b09febef572908
-    sha256: 17862067ee8041d9e69db12b917572dde4190cf8c4830d217880a4351139e3d7
+    md5: 3c32b1aac6372685e9eb832b8d789b80
+    sha256: 4c130699ffcfddff7073ac079558d3e970b3b6198e096d586183e05d1ee714ac
   category: main
   optional: false
 - name: lerc
@@ -1083,10 +1083,10 @@ package:
     libgcc-ng: '>=12'
     libstdcxx-ng: '>=12'
     libzlib: '>=1.2.13,<1.3.0a0'
-  url: https://conda.anaconda.org/conda-forge/linux-64/libprotobuf-3.21.12-h3eb15da_0.conda
+  url: https://conda.anaconda.org/conda-forge/linux-64/libprotobuf-3.21.12-hfc55251_1.conda
   hash:
-    md5: 4b36c68184c6c85d88c6e595a32a1ede
-    sha256: 760118d7879b5524e118db1c75cc2a5dfceb2c4940dcae94751a94786c8cf12b
+    md5: 7257c60b64b998658f26bdbeb38e43c7
+    sha256: f5d489fa007074e6af0c01aed93893a3d4f41849924267cadef473840e57625b
   category: main
   optional: false
 - name: librttopo
@@ -1104,16 +1104,16 @@ package:
   category: main
   optional: false
 - name: libsqlite
-  version: 3.42.0
+  version: 3.43.0
   manager: conda
   platform: linux-64
   dependencies:
     libgcc-ng: '>=12'
     libzlib: '>=1.2.13,<1.3.0a0'
-  url: https://conda.anaconda.org/conda-forge/linux-64/libsqlite-3.42.0-h2797004_0.conda
+  url: https://conda.anaconda.org/conda-forge/linux-64/libsqlite-3.43.0-h2797004_0.conda
   hash:
-    md5: fdaae20a1cf7cd62130a0973190a31b7
-    sha256: 72e958870f49174ebc0ddcd4129e9a9f48de815f20aa3b553f136b514f29bb3a
+    md5: 903fa782a9067d5934210df6d79220f6
+    sha256: e715fab7ec6b3f3df2a5962ef372ff0f871d215fe819482dcd80357999513652
   category: main
   optional: false
 - name: libssh2
@@ -1176,18 +1176,18 @@ package:
   category: main
   optional: false
 - name: libzip
-  version: 1.9.2
+  version: 1.10.1
   manager: conda
   platform: linux-64
   dependencies:
     bzip2: '>=1.0.8,<2.0a0'
     libgcc-ng: '>=12'
-    libzlib: '>=1.2.12,<1.3.0a0'
-    openssl: '>=3.0.5,<4.0a0'
-  url: https://conda.anaconda.org/conda-forge/linux-64/libzip-1.9.2-hc929e4a_1.tar.bz2
+    libzlib: '>=1.2.13,<1.3.0a0'
+    openssl: '>=3.1.2,<4.0a0'
+  url: https://conda.anaconda.org/conda-forge/linux-64/libzip-1.10.1-h2629f0a_0.conda
   hash:
-    md5: 5b122b50e738c4be5c3f2899f010d7cf
-    sha256: e2dbd5239f62fbac4f00f828b1de0ea5898d6ed5c1f3049baaf4dfcc4ebdbe7c
+    md5: d597567092897b1f1c7350f32e03944e
+    sha256: a143d176e1ba47a50444b015fcb15a9ac98d2b963b251469f256d2472d33c678
   category: main
   optional: false
 - name: mpfr
@@ -1518,14 +1518,14 @@ package:
     libgcc-ng: '>=12'
     libjpeg-turbo: '>=2.1.5.1,<3.0a0'
     libstdcxx-ng: '>=12'
-    libwebp-base: '>=1.3.0,<2.0a0'
+    libwebp-base: '>=1.3.1,<2.0a0'
     libzlib: '>=1.2.13,<1.3.0a0'
     xz: '>=5.2.6,<6.0a0'
     zstd: '>=1.5.2,<1.6.0a0'
-  url: https://conda.anaconda.org/conda-forge/linux-64/libtiff-4.5.1-h8b53f26_0.conda
+  url: https://conda.anaconda.org/conda-forge/linux-64/libtiff-4.5.1-h8b53f26_1.conda
   hash:
-    md5: 8ad377fb60abab446a9f02c62b3c2190
-    sha256: 920943ad46869938bd070ccd4c0117594e07538bc6b27b75462594c67b6f215d
+    md5: 5b09e13d732dda1a2bc9adc711164f4d
+    sha256: 631ccfdd460eda9661b6371aa459fe5ce174816365873deb5af955c9e10bf8c2
   category: main
   optional: false
 - name: libxkbcommon
@@ -1575,20 +1575,20 @@ package:
   category: main
   optional: false
 - name: nss
-  version: '3.89'
+  version: '3.92'
   manager: conda
   platform: linux-64
   dependencies:
     __glibc: '>=2.17,<3.0.a0'
     libgcc-ng: '>=12'
-    libsqlite: '>=3.40.0,<4.0a0'
+    libsqlite: '>=3.42.0,<4.0a0'
     libstdcxx-ng: '>=12'
     libzlib: '>=1.2.13,<1.3.0a0'
     nspr: '>=4.35,<5.0a0'
-  url: https://conda.anaconda.org/conda-forge/linux-64/nss-3.89-he45b914_0.conda
+  url: https://conda.anaconda.org/conda-forge/linux-64/nss-3.92-h1d7d5a4_0.conda
   hash:
-    md5: 2745719a58eeaab6657256a3f142f099
-    sha256: 6d512e4a7ffae4fed9feac2cb2037398c78ade47e5358fc79ac3e58494de0cad
+    md5: 22c89a3d87828fe925b310b9cdf0f574
+    sha256: a57445e96ace70b0c4075a95bf3308f174aa2a3865b37b486e021b5ab7e50b80
   category: main
   optional: false
 - name: python
@@ -1617,19 +1617,19 @@ package:
   category: main
   optional: false
 - name: sqlite
-  version: 3.42.0
+  version: 3.43.0
   manager: conda
   platform: linux-64
   dependencies:
     libgcc-ng: '>=12'
-    libsqlite: 3.42.0
+    libsqlite: 3.43.0
     libzlib: '>=1.2.13,<1.3.0a0'
-    ncurses: '>=6.3,<7.0a0'
+    ncurses: '>=6.4,<7.0a0'
     readline: '>=8.2,<9.0a0'
-  url: https://conda.anaconda.org/conda-forge/linux-64/sqlite-3.42.0-h2c6b66d_0.conda
+  url: https://conda.anaconda.org/conda-forge/linux-64/sqlite-3.43.0-h2c6b66d_0.conda
   hash:
-    md5: 1192f6ec654a5bc4ee1d64bdc4a3e5cc
-    sha256: 9cf59fa9891248e0e3a86a41041156cec367653d423e5d8a09b4c8ab98441a27
+    md5: 713f9eac95d051abe14c3774376854fe
+    sha256: b3db86c1ae67bca79328a5d517330e1c95cf4e1f666e46ac9a90e64caf86449d
   category: main
   optional: false
 - name: xcb-util
@@ -2837,15 +2837,15 @@ package:
   category: main
   optional: false
 - name: wheel
-  version: 0.41.1
+  version: 0.41.2
   manager: conda
   platform: linux-64
   dependencies:
     python: '>=3.7'
-  url: https://conda.anaconda.org/conda-forge/noarch/wheel-0.41.1-pyhd8ed1ab_0.conda
+  url: https://conda.anaconda.org/conda-forge/noarch/wheel-0.41.2-pyhd8ed1ab_0.conda
   hash:
-    md5: 8f467ba2db2b5470d297953d9c1f9c7d
-    sha256: a27e2c2709245386ebffae865650b5d3f383530b809480c3083f7ae258759303
+    md5: 1ccd092478b3e0ee10d7a891adbf8a4f
+    sha256: 21bcec5373b04d739ab65252b5532b04a08d229865ebb24b5b94902d6d0a77b0
   category: main
   optional: false
 - name: xcb-util-image
@@ -3608,17 +3608,17 @@ package:
     eigen: ''
     gflags: '>=2.2.2,<2.3.0a0'
     glog: '>=0.6.0,<0.7.0a0'
-    libblas: '>=3.8.0,<4.0a0'
-    libcblas: '>=3.8.0,<4.0a0'
-    libgcc-ng: '>=10.3.0'
-    liblapack: '>=3.8.0,<4.0a0'
-    libstdcxx-ng: '>=10.3.0'
+    libblas: '>=3.9.0,<4.0a0'
+    libcblas: '>=3.9.0,<4.0a0'
+    libgcc-ng: '>=12'
+    liblapack: '>=3.9.0,<4.0a0'
+    libstdcxx-ng: '>=12'
     suitesparse: '>=5.10.1,<6.0a0'
     tbb: ''
-  url: https://conda.anaconda.org/conda-forge/linux-64/ceres-solver-2.1.0-hf302a74_1.tar.bz2
+  url: https://conda.anaconda.org/conda-forge/linux-64/ceres-solver-2.1.0-h2ea6fbf_2.conda
   hash:
-    md5: a57f1dde055134c20c8829d9247de085
-    sha256: 32615586199bd619394cc1d2b3a81430a1cda67afc30f3324b4042e39fd3b371
+    md5: d35b8bb324756b7cff6ef139c602ae29
+    sha256: 65f9d811f628e98463cee057bf37233b6c6485cb4ce180e7e0ea7b72933a525c
   category: main
   optional: false
 - name: cryptography
@@ -4078,16 +4078,16 @@ package:
   category: main
   optional: false
 - name: identify
-  version: 2.5.26
+  version: 2.5.27
   manager: conda
   platform: linux-64
   dependencies:
     python: '>=3.6'
     ukkonen: ''
-  url: https://conda.anaconda.org/conda-forge/noarch/identify-2.5.26-pyhd8ed1ab_0.conda
+  url: https://conda.anaconda.org/conda-forge/noarch/identify-2.5.27-pyhd8ed1ab_0.conda
   hash:
-    md5: 1ca86f154e13f4aa20b48e20d6bbf924
-    sha256: 9ee6fe7a65b17684c6fc46adb2b35e08a3bf48c7d39bed5a9c17ee6050574066
+    md5: 6fbde8d3bdd1874132a1b26a3554b22c
+    sha256: 5aece5a948e881e2450be73002e52cd27df089b6ea64416f7694304307f66bd2
   category: main
   optional: false
 - name: libgdal
@@ -4236,20 +4236,20 @@ package:
   category: main
   optional: false
 - name: bump-my-version
-  version: 0.9.2
+  version: 0.9.3
   manager: conda
   platform: linux-64
   dependencies:
     click: ''
     pydantic: <2.0.0
-    python: '>=3.7'
+    python: '>=3.8'
     rich: ''
     rich-click: ''
     tomlkit: ''
-  url: https://conda.anaconda.org/conda-forge/noarch/bump-my-version-0.9.2-pyhd8ed1ab_0.conda
+  url: https://conda.anaconda.org/conda-forge/noarch/bump-my-version-0.9.3-pyhd8ed1ab_0.conda
   hash:
-    md5: d64fc21704aefeb8095abcc7c15482cb
-    sha256: 71f49877ec5ac7d58bd5c1eacb73a2fc8917b93f3f41711c4da5aa89823e50b0
+    md5: 24f0c263af3783651f77b021a6ad97a8
+    sha256: b5530371b54677cb72d93ae091052327b2c809a6066d85366af4f3f0728888eb
   category: main
   optional: false
 - name: gdal
@@ -4971,16 +4971,29 @@ package:
   category: main
   optional: false
 - name: sphinxcontrib-serializinghtml
-  version: 1.1.8
+  version: 1.1.9
   manager: conda
   platform: linux-64
   dependencies:
     python: '>=3.9'
     sphinx: '>=5'
-  url: https://conda.anaconda.org/conda-forge/noarch/sphinxcontrib-serializinghtml-1.1.8-pyhd8ed1ab_0.conda
+  url: https://conda.anaconda.org/conda-forge/noarch/sphinxcontrib-serializinghtml-1.1.9-pyhd8ed1ab_0.conda
+  hash:
+    md5: 0612e497d7860728f2cda421ea2aec09
+    sha256: c5710ae7bb7465f25a29cc845d9fb6ad0ea561972d796d379fcb48d801e96d6d
+  category: main
+  optional: false
+- name: sphinxext-rediraffe
+  version: 0.2.7
+  manager: conda
+  platform: linux-64
+  dependencies:
+    python: '>=3.6'
+    sphinx: '>=2.0'
+  url: https://conda.anaconda.org/conda-forge/noarch/sphinxext-rediraffe-0.2.7-pyhd8ed1ab_0.tar.bz2
   hash:
-    md5: 1e6eb6f55c967ed84a6c87306e7a9411
-    sha256: 4117022ed18bce8852389885decbf26519d016a8926a0dc21923f77789d64455
+    md5: e54a2fc775c162a72243797569abd9de
+    sha256: 87c9dd79c0bb77904ce55dda2478f06780b2e8b635560fc8e85178c7007fd4a5
   category: main
   optional: false
 - name: sphinx-selective-exclude

environments/main/environment.yml

@@ -48,6 +48,7 @@ dependencies:
   - myst-parser ~=2.0.0
   - sphinx-click ~=3.0.1
   - sphinx-rtd-theme ~=1.2.2
+  - sphinxext-rediraffe ~=0.2.7
   - autodoc-pydantic ~=1.9.0
   # TODO: What does this do? Do we need it?
   # - sphinx-autodoc-typehints ~=1.12.0