Add NXstress smoke-test demo script

.github/workflows/package.yaml

@@ -1,6 +1,6 @@
 name: Pixi Packaging and Deployment
 
-on:
+on:  # yamllint disable-line rule:truthy
   workflow_dispatch:
   push:
     branches: [main]

.github/workflows/unittest.yaml

@@ -1,6 +1,6 @@
 name: unit-test
 
-on:
+on:  # yamllint disable-line rule:truthy
   workflow_dispatch:
   pull_request:   # Run on pull requests targeting any base branch
   push:

.gitignore

@@ -78,6 +78,8 @@ instance/
 
 # Sphinx documentation
 docs/_build/
+#   ... ignore auto-generated Sphinx API docs
+docs/developer/source/api/modules.rst
 
 # PyBuilder
 target/

.pre-commit-config.yaml

@@ -14,28 +14,36 @@ repos:
         exclude: "conda.recipe/meta.yaml"
       - id: end-of-file-fixer
       - id: trailing-whitespace
+
   - repo: https://github.com/astral-sh/ruff-pre-commit
     rev: v0.14.14
     hooks:
       - id: ruff-check
         args: [--fix, --exit-non-zero-on-fix]
       - id: ruff-format
+
+# yamllint disable
 #  - repo: https://github.com/codespell-project/codespell
 #    rev: v2.4.1
 #    hooks:
 #      - id: codespell
+# yamllint disable
+
   - repo: https://github.com/gitleaks/gitleaks
     rev: v8.30.0
     hooks:
       - id: gitleaks
+
   - repo: https://github.com/adrienverge/yamllint/
     rev: v1.38.0
     hooks:
       - id: yamllint
+
   - repo: https://github.com/ComPWA/taplo-pre-commit
     rev: v0.9.3
     hooks:
       - id: taplo-format
+
   - repo: local
     hooks:
       - id: pixi-lock-check

.readthedocs.yml

@@ -2,8 +2,11 @@
 version: 2
 
 conda:
-  environment: docs/rtd/environment.yml
+  environment: docs/user/environment.yml
+
+sphinx:
+  configuration: docs/user/source/conf.py
 
 python:
-  version: 3.7
+  version: 3.11
   system_packages: true

codecov.yaml

@@ -1,7 +1,7 @@
 # Configuration file for codecov reporting code coverage
 
 # Disable codecov comments in every PR
-comment: off
+comment: false
 
 # files to ignore
 ignore:

docs/developer/source/api/.gitignore

@@ -0,0 +1,7 @@
+# Ignore autogenerated API documentation
+pyrs*.rst
+
+# ... but keep specific handwritten files:
+!modules.rst
+!manual_api.rst
+!pyRS.rst

docs/developer/source/api/modules.rst

@@ -0,0 +1,7 @@
+pyrs
+====
+
+.. toctree::
+   :maxdepth: 4
+
+   pyrs

docs/developer/source/bibliography.rst

@@ -0,0 +1,21 @@
+:Author: Chris Fancher
+:Date: 05/12/2021
+:Keywords: list of references
+
+::
+  DUPLICATE from `docs/user/source/bibliography.rst` to prevent an out-of-tree reference.
+
+Bibliography
+============
+
+.. [NumPy] Oliphant T E 2007 Comput. Sci. Eng. vol9 p10–20
+
+.. [Matplotlib] Hunter J D 2007 Comput. Sci. Eng. vol9  p90–95 ISSN 1521-9615
+
+.. [SciPy] Jones E, Oliphant T, Peterson P et al.
+   2001– SciPy: Open source scientific tools for Python URL
+   http://www.scipy.org/
+
+.. [mantid] O. Arnold et al.,
+   Nucl. Instruments Methods Phys. Res. Set. A Accel. Spectrometers, Detect. Assoc. Equip. 764, 156 (2014)
+   https://www.mantidproject.org/