Merge branch 'main' of github.com:rs-station/laue-dials

Updating local repo before documentation pushes

.pre-commit-config.yaml

@@ -1,12 +1,12 @@
 repos:
 -   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.5.0
+    rev: v4.6.0
     hooks:
     -   id: check-docstring-first
     -   id: check-yaml
     -   id: end-of-file-fixer
     -   id: trailing-whitespace
 -   repo: https://github.com/psf/black
-    rev: 24.1.1
+    rev: 24.8.0
     hooks:
     -   id: black

CONTRIBUTING.rst

@@ -44,6 +44,11 @@ and use Python's built-in web server for a preview in your web browser
 
     python3 -m http.server --directory 'docs/_build/html'
 
+If you wish to ``make html`` directly, be sure to install ``pandoc`` via
+
+    ``conda install pandoc``
+
+first.
 
 Code Contributions
 ==================

docs/conf.py

@@ -77,8 +77,12 @@
     "sphinx_rtd_theme",
     "libtbx.sphinx.phil",
     "libtbx.sphinx.python_string",
+    "nbsphinx",
 ]
 
+# Set nbsphinx parameters
+nbsphinx_execute = "never"
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
 

docs/index.rst

@@ -14,6 +14,7 @@ Contents
    Tutorials <tutorials/notebooks>
    Command-Line Reference <cli/functions>
    Full API Reference <api/modules>
+   Jupyter Tutorials <notebooks/tutorials>
 
 
 Indices and tables