ercius · ercius · Jul 13, 2026 · Jul 13, 2026 · Jul 13, 2026
diff --git a/.gitignore b/.gitignore
@@ -90,7 +90,9 @@ ncempy/venv
 
 # Rope project settings
 .ropeproject
-sphinx-apidoc
+
+# Auto-generated by sphinxcontrib.apidoc on each docs build (see docs/conf.py)
+docs/ncempy*.rst
 
 # Vim
 tags

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,18 @@
+version: 2
+
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.12"
+
+sphinx:
+  configuration: docs/conf.py
+  fail_on_warning: false
+
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - jupyter
+    - requirements: docs/requirements.txt
diff --git a/README.rst b/README.rst
@@ -29,6 +29,9 @@ The openNCEM collection comes with different components, described below.
 **tools**
     The tools build leveraging the algorithms and routines provided in the libraries/packages. They are subordered by the different problems they address.
 
+**python_titan**
+    A set of open source automation packages for Thermo Fisher transmission electron microscopes.
+
 Commands
 ========
 

diff --git a/docs/conf.py b/docs/conf.py
@@ -34,10 +34,41 @@
     'sphinx.ext.todo',
     'sphinx.ext.viewcode',
     'sphinx.ext.napoleon',
+    'sphinx.ext.intersphinx',
+    'sphinxcontrib.apidoc',
 ]
 
 napoleon_include_init_with_doc = False
 
+# Document docstring "Attributes" sections as :ivar: fields instead of as
+# separate autodoc attribute entries. Several classes (e.g. ncempy.io.dm.fileDM)
+# declare their attributes via __slots__, which autodoc also picks up directly;
+# without this, each one is documented twice and Sphinx raises "duplicate
+# object description" warnings.
+napoleon_use_ivar = True
+
+# -- sphinxcontrib.apidoc ---------------------------------------------------
+# Regenerates the ncempy.*.rst stub files from the package source on every
+# build, instead of hand-maintaining them. This keeps the module list from
+# drifting out of sync with the actual submodules.
+apidoc_module_dir = '../ncempy'
+apidoc_output_dir = '.'
+apidoc_excluded_paths = ['test']
+apidoc_separate_modules = True
+apidoc_module_first = True
+apidoc_toc_file = False
+
+# -- sphinx.ext.intersphinx --------------------------------------------------
+# Lets type references in docstrings (e.g. `numpy.ndarray`) link out to the
+# referenced project's own docs.
+intersphinx_mapping = {
+    'python': ('https://docs.python.org/3', None),
+    'numpy': ('https://numpy.org/doc/stable/', None),
+    'scipy': ('https://docs.scipy.org/doc/scipy/', None),
+    'h5py': ('https://docs.h5py.org/en/stable/', None),
+    'matplotlib': ('https://matplotlib.org/stable/', None),
+}
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -29,6 +29,9 @@ The openNCEM collection comes with different components. The general functionali
     ncempy - openNCEM's python package<ncempy>
     tools - wrapping the provided functionality into useful tools<tools>
 
+**python_titan**
+    A set of open source automation packages for Thermo Fisher transmission electron microscopes.
+
 Examples
 --------
 Simple file reading
@@ -61,6 +64,20 @@ Here is how to open a DM file and have access to the internal file parameters
    >>>     print(dm0.metaData) # all of the interesting metadata for this data set (pixel size, accelerating voltage, etc.)
    >>>     print(dm0.allTags) # all of the tags in the file including tags specific to the Digital Micrpograph software program
 
+Reading Dectris Arina 4D-STEM data
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+The Dectris Arina detector writes its 4D-STEM data set across an HDF5 master
+file and one or more linked data files. Use `ncempy.io.dectris` to load the
+full 4D data set from the master file.
+
+.. code-block:: python
+
+   >>> import ncempy.io as nio
+   >>> with nio.dectris.fileDECTRIS('/path/to/file/master.h5') as f0:
+   >>>     data = f0.getDataset() # the full 4D data set, shape [scanY, scanX, frameY, frameX]
+   >>>     print(data['data'].shape)
+   >>>     print(f0.getMetadata()) # scan metadata (e.g. pixel size), if available
+
 License
 -------
 

diff --git a/docs/ncempy.algo.rst b/docs/ncempy.algo.rst
diff --git a/docs/ncempy.command_line.rst b/docs/ncempy.command_line.rst
diff --git a/docs/ncempy.edstomo.rst b/docs/ncempy.edstomo.rst
diff --git a/docs/ncempy.eval.rst b/docs/ncempy.eval.rst
diff --git a/docs/ncempy.io.rst b/docs/ncempy.io.rst
diff --git a/docs/ncempy.rst b/docs/ncempy.rst
diff --git a/docs/ncempy.viz.rst b/docs/ncempy.viz.rst
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -0,0 +1,3 @@
+sphinx
+sphinx-rtd-theme
+sphinxcontrib-apidoc