Merge pull request #129 from MridulS/bumptox

copier bump for pypi publish

Author: MridulS

.copier-answers.yml

@@ -1,5 +1,5 @@
 # Changes here will be overwritten by Copier; NEVER EDIT MANUALLY
-_commit: 18e7005
+_commit: cdbfd9c
 _src_path: gh:scipp/copier_template
 description: Data reduction for NMX at the European Spallation Source.
 max_python: '3.13'

.github/workflows/release.yml

@@ -68,7 +68,7 @@ jobs:
     if: github.event_name == 'release' && github.event.action == 'published'
     steps:
       - uses: actions/download-artifact@v4
-      - uses: pypa/gh-action-pypi-publish@v1.8.14
+      - uses: pypa/gh-action-pypi-publish@v1.12.4
 
   upload_conda:
     name: Deploy Conda

.gitignore

@@ -14,6 +14,7 @@ venv
 .venv
 
 # Caches
+*.DS_Store
 .clangd/
 *.ipynb_checkpoints
 __pycache__/

docs/index.md

@@ -1,10 +1,42 @@
-# ESSnmx
+:::{image} _static/logo.svg
+:class: only-light
+:alt: ESSnmx
+:width: 60%
+:align: center
+:::
+:::{image} _static/logo-dark.svg
+:class: only-dark
+:alt: ESSnmx
+:width: 60%
+:align: center
+:::
 
-<span style="font-size:1.2em;font-style:italic;color:#5a5a5a">
+```{raw} html
+   <style>
+    .transparent {display: none; visibility: hidden;}
+    .transparent + a.headerlink {display: none; visibility: hidden;}
+   </style>
+```
+
+```{role} transparent
+```
+
+# {transparent}`ESSnmx`
+
+<span style="font-size:1.2em;font-style:italic;color:var(--pst-color-text-muted)">
   Data reduction for NMX at the European Spallation Source.
   </br></br>
 </span>
 
+:::{include} user-guide/installation.md
+:heading-offset: 1
+:::
+
+## Get in touch
+
+- If you have questions that are not answered by these documentation pages, ask on [discussions](https://github.com/scipp/essnmx/discussions). Please include a self-contained reproducible example if possible.
+- Report bugs (including unclear, missing, or wrong documentation!), suggest features or view the source code [on GitHub](https://github.com/scipp/essnmx).
+
 ```{toctree}
 ---
 hidden:

docs/user-guide/index.md

@@ -2,10 +2,11 @@
 
 ```{toctree}
 ---
-maxdepth: 2
+maxdepth: 1
 ---
 
 workflow
 workflow_chunk
 scaling_workflow
+installation
 ```

docs/user-guide/installation.md

@@ -0,0 +1,16 @@
+# Installation
+
+To install ESSnmx and all of its dependencies, use
+
+`````{tab-set}
+````{tab-item} pip
+```sh
+pip install essnmx
+```
+````
+````{tab-item} conda
+```sh
+conda install -c conda-forge -c scipp essnmx
+```
+````
+`````