Fix Sphinx use in release guide and fix some links in docs

Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
pyxem · Jul 24, 2023 · 309d920 · 309d920
1 parent b6a86f5
commit 309d920
Show file tree

Hide file tree

Showing 8 changed files with 13 additions and 13 deletions.
diff --git a/RELEASE.rst b/RELEASE.rst
@@ -19,7 +19,7 @@ Preparation
 
 - Run tutorial notebooks and examples in the documentation locally and confirm that they
   produce the expected results.
-  From time to time, check the documentation links (``make linkchecker``) and fix any
+  From time to time, check the documentation links (``make linkcheck``) and fix any
   broken ones.
 
 - Review the contributor list ``__credits__`` in ``kikuchipy/release.py`` to ensure all

diff --git a/doc/tutorials/geometrical_ebsd_simulations.ipynb b/doc/tutorials/geometrical_ebsd_simulations.ipynb
@@ -143,7 +143,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "We'll build up the reflector list using [diffsims.crystallography.ReciprocalLatticeVector](https://diffsims.readthedocs.io/en/latest/reference.html#diffsims.crystallography.ReciprocalLatticeVector)"
+    "We'll build up the reflector list using [diffsims.crystallography.ReciprocalLatticeVector](https://diffsims.readthedocs.io/en/latest/reference/generated/diffsims.crystallography.ReciprocalLatticeVector.html)"
    ]
   },
   {
@@ -479,7 +479,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.9"
+   "version": "3.11.4"
   }
  },
  "nbformat": 4,

diff --git a/doc/tutorials/hough_indexing.ipynb b/doc/tutorials/hough_indexing.ipynb
@@ -26,7 +26,7 @@
     "Note\n",
     "\n",
     "PyEBSDIndex is an optional dependency of kikuchipy, and can be installed with both `pip` and `conda` (from `conda-forge`).\n",
-    "To install PyEBSDIndex, see their [installation instructions](https://pyebsdindex.readthedocs.io/en/latest/installation.html).\n",
+    "To install PyEBSDIndex, see their [installation instructions](https://pyebsdindex.readthedocs.io/en/latest/user/installation.html).\n",
     "\n",
     "PyEBSDIndex supports indexing face centered and body centered cubic (FCC and BCC) materials.\n",
     "\n",

diff --git a/doc/tutorials/hybrid_indexing.ipynb b/doc/tutorials/hybrid_indexing.ipynb
@@ -397,7 +397,7 @@
     "Note\n",
     "\n",
     "PyEBSDIndex is an optional dependency of kikuchipy, and can be installed with both `pip` and `conda` (from `conda-forge`).\n",
-    "To install PyEBSDIndex, see their [installation instructions](https://pyebsdindex.readthedocs.io/en/latest/installation.html).\n",
+    "To install PyEBSDIndex, see their [installation instructions](https://pyebsdindex.readthedocs.io/en/latest/user/installation.html).\n",
     "\n",
     "PyEBSDIndex supports indexing face centered and body centered cubic (FCC and BCC) materials.\n",
     "\n",

diff --git a/doc/tutorials/pc_calibration_moving_screen_technique.ipynb b/doc/tutorials/pc_calibration_moving_screen_technique.ipynb
@@ -242,7 +242,7 @@
     "Note\n",
     "\n",
     "PyEBSDIndex is an optional dependency of kikuchipy, and can be installed with both `pip` and `conda` (from `conda-forge`).\n",
-    "To install PyEBSDIndex, see their [installation instructions](https://pyebsdindex.readthedocs.io/en/latest/installation.html).\n",
+    "To install PyEBSDIndex, see their [installation instructions](https://pyebsdindex.readthedocs.io/en/latest/user/installation.html).\n",
     "\n",
     "PyEBSDIndex supports indexing face centered and body centered cubic (FCC and BCC) materials.\n",
     "\n",
@@ -409,7 +409,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.9"
+   "version": "3.11.4"
   }
  },
  "nbformat": 4,

diff --git a/doc/tutorials/pc_extrapolate_plane.ipynb b/doc/tutorials/pc_extrapolate_plane.ipynb
@@ -266,7 +266,7 @@
     "Note\n",
     "\n",
     "PyEBSDIndex is an optional dependency of kikuchipy, and can be installed with both `pip` and `conda` (from `conda-forge`).\n",
-    "To install PyEBSDIndex, see their [installation instructions](https://pyebsdindex.readthedocs.io/en/latest/installation.html).\n",
+    "To install PyEBSDIndex, see their [installation instructions](https://pyebsdindex.readthedocs.io/en/latest/user/installation.html).\n",
     "\n",
     "PyEBSDIndex supports indexing face centered and body centered cubic (FCC and BCC) materials.\n",
     "\n",
@@ -1309,7 +1309,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.10"
+   "version": "3.11.4"
   }
  },
  "nbformat": 4,

diff --git a/doc/tutorials/pc_fit_plane.ipynb b/doc/tutorials/pc_fit_plane.ipynb
@@ -575,7 +575,7 @@
     "Note\n",
     "\n",
     "PyEBSDIndex is an optional dependency of kikuchipy, and can be installed with both `pip` and `conda` (from `conda-forge`).\n",
-    "To install PyEBSDIndex, see their [installation instructions](https://pyebsdindex.readthedocs.io/en/latest/installation.html).\n",
+    "To install PyEBSDIndex, see their [installation instructions](https://pyebsdindex.readthedocs.io/en/latest/user/installation.html).\n",
     "\n",
     "PyEBSDIndex supports indexing face centered and body centered cubic (FCC and BCC) materials.\n",
     "\n",
@@ -1395,7 +1395,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.10"
+   "version": "3.11.4"
   }
  },
  "nbformat": 4,

diff --git a/doc/tutorials/pc_orientation_dependence.ipynb b/doc/tutorials/pc_orientation_dependence.ipynb
@@ -527,7 +527,7 @@
     "Note\n",
     "\n",
     "PyEBSDIndex is an optional dependency of kikuchipy, and can be installed with both `pip` and `conda` (from `conda-forge`).\n",
-    "To install PyEBSDIndex, see their [installation instructions](https://pyebsdindex.readthedocs.io/en/latest/installation.html).\n",
+    "To install PyEBSDIndex, see their [installation instructions](https://pyebsdindex.readthedocs.io/en/latest/user/installation.html).\n",
     "\n",
     "PyEBSDIndex supports indexing face centered and body centered cubic (FCC and BCC) materials.\n",
     "\n",
@@ -1640,7 +1640,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.10"
+   "version": "3.11.4"
   }
  },
  "nbformat": 4,