Merge pull request #362 from jonwright/master

try to build the API docs

.readthedocs.yaml

@@ -30,6 +30,6 @@ sphinx:
 # Optional but recommended, declare the Python requirements required
 # to build your documentation
 # See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
-# python:
-#   install:
-#     - requirements: docs/requirements.txt
+python:
+  install:
+    - requirements: docs/sphx/requirements.txt

docs/sphx/requirements.txt

@@ -0,0 +1,177 @@
+#
+# This file is autogenerated by pip-compile with Python 3.11
+# by the following command:
+#
+#    pip-compile --output-file=docs/sphx/requirements.txt
+#
+bslz4-to-sparse==0.0.15
+    # via ImageD11 (setup.py)
+certifi==2024.8.30
+    # via requests
+charset-normalizer==3.4.0
+    # via requests
+click==8.1.7
+    # via dask
+cloudpickle==3.1.0
+    # via dask
+contourpy==1.3.1
+    # via matplotlib
+cycler==0.12.1
+    # via matplotlib
+dask[array]==2024.12.0
+    # via orix
+diffpy-structure==3.3.0 ; python_version >= "3"
+    # via
+    #   ImageD11 (setup.py)
+    #   orix
+fabio==2024.9.0 ; python_version >= "3" or sys_platform != "win32"
+    # via ImageD11 (setup.py)
+fast-histogram==0.14
+    # via ImageD11 (setup.py)
+fonttools==4.55.2
+    # via matplotlib
+fsspec==2024.10.0
+    # via dask
+h5py==3.12.1
+    # via
+    #   ImageD11 (setup.py)
+    #   bslz4-to-sparse
+    #   fabio
+    #   hdf5plugin
+    #   orix
+hdf5plugin==5.0.0 ; python_version >= "3"
+    # via
+    #   ImageD11 (setup.py)
+    #   fabio
+idna==3.10
+    # via requests
+imageio==2.36.1
+    # via scikit-image
+importlib-metadata==8.5.0
+    # via dask
+iniconfig==2.0.0
+    # via pytest
+kiwisolver==1.4.7
+    # via matplotlib
+lazy-loader==0.4
+    # via scikit-image
+llvmlite==0.43.0
+    # via numba
+locket==1.0.0
+    # via partd
+lxml==5.3.0
+    # via fabio
+matplotlib==3.9.3
+    # via
+    #   ImageD11 (setup.py)
+    #   matplotlib-scalebar
+    #   orix
+matplotlib-scalebar==0.8.1
+    # via orix
+networkx==3.4.2
+    # via scikit-image
+numba==0.60.0 ; python_version >= "3"
+    # via
+    #   ImageD11 (setup.py)
+    #   orix
+numpy==1.26.4 ; python_version >= "3"
+    # via
+    #   ImageD11 (setup.py)
+    #   bslz4-to-sparse
+    #   contourpy
+    #   dask
+    #   diffpy-structure
+    #   fabio
+    #   fast-histogram
+    #   h5py
+    #   imageio
+    #   matplotlib
+    #   numba
+    #   orix
+    #   pycifrw
+    #   scikit-image
+    #   scipy
+    #   tifffile
+    #   xfab
+orix==0.13.2 ; python_version >= "3"
+    # via ImageD11 (setup.py)
+packaging==24.2
+    # via
+    #   dask
+    #   lazy-loader
+    #   matplotlib
+    #   pooch
+    #   pytest
+    #   scikit-image
+partd==1.4.2
+    # via dask
+pillow==11.0.0
+    # via
+    #   fabio
+    #   imageio
+    #   matplotlib
+    #   scikit-image
+platformdirs==4.3.6
+    # via pooch
+pluggy==1.5.0
+    # via pytest
+ply==3.11
+    # via pycifrw
+pooch==1.8.2
+    # via orix
+pycifrw==4.4.6
+    # via
+    #   diffpy-structure
+    #   orix
+    #   xfab
+pyopengl==3.1.7
+    # via pyopengltk
+pyopengltk==0.0.4
+    # via ImageD11 (setup.py)
+pyparsing==3.2.0
+    # via matplotlib
+pytest==8.3.4
+    # via ImageD11 (setup.py)
+python-dateutil==2.9.0.post0
+    # via matplotlib
+pyyaml==6.0.2
+    # via
+    #   ImageD11 (setup.py)
+    #   dask
+requests==2.32.3
+    # via pooch
+scikit-image==0.24.0
+    # via ImageD11 (setup.py)
+scipy==1.14.1
+    # via
+    #   ImageD11 (setup.py)
+    #   orix
+    #   scikit-image
+six==1.17.0
+    # via
+    #   ImageD11 (setup.py)
+    #   python-dateutil
+    #   xfab
+threadpoolctl==3.5.0 ; python_version >= "3"
+    # via ImageD11 (setup.py)
+tifffile==2024.9.20
+    # via scikit-image
+toolz==1.0.0
+    # via
+    #   dask
+    #   partd
+tqdm==4.67.1
+    # via
+    #   ImageD11 (setup.py)
+    #   orix
+typing-extensions==4.12.2
+    # via orix
+urllib3==2.2.3
+    # via requests
+xfab==0.0.6
+    # via ImageD11 (setup.py)
+zipp==3.21.0
+    # via importlib-metadata
+
+# The following packages are considered to be unsafe in a requirements file:
+# setuptools