From b135aa16e73368d2b6815b3346d8c2c6709b3962 Mon Sep 17 00:00:00 2001 From: Jakob Lass Date: Mon, 14 Apr 2025 09:29:41 +0200 Subject: [PATCH] Move badges Add contribution Add contact Move tutorials higher up --- source/index.rst | 62 +++++++++++++++++++++++++++--------------------- 1 file changed, 35 insertions(+), 27 deletions(-) diff --git a/source/index.rst b/source/index.rst index 97833c4..0ec2d49 100644 --- a/source/index.rst +++ b/source/index.rst @@ -5,6 +5,21 @@ AMBER documentation =================== +.. image:: https://gitea.psi.ch/lass_j/AMBER/actions/workflows/test.yaml/badge.svg + :height: 20 + :alt: Test Status + +.. image:: https://readthedocs.org/projects/AMBER-ds4ms/badge/?style=plastic + :height: 20 + :alt: Read the Docs + +.. image:: https://img.shields.io/pypi/v/AMBER-ds4ms + :height: 20 + :alt: PyPI - Version + +.. image:: https://img.shields.io/pypi/pyversions/AMBER-ds4ms + :height: 20 + :alt: PyPI - Python Version This is the documentation for the **A** lgorithm for **M** ultiplexing spectrometer **B** ackground **E** stimation with **R** otation-independence **AMBER** which is a method to estimate and background within 3D data sets. @@ -14,16 +29,6 @@ This software is the result of the collaboration between the instrument responsi the fifth call for Collaborative Research Data Science Projects. -Badges ------- - -.. image:: https://gitea.psi.ch/lass_j/AMBER/actions/workflows/test.yaml/badge.svg - :width: 50 - :alt: Test Status - - - - Installation @@ -40,6 +45,19 @@ Alternatively, the newest version can be installed directly from the source repo python -m pip install git+https://gitea.psi.ch/lass_j/AMBER.git@main +Documentation & Tutorials +------------------------- + +For **AMBER** the following tutorials have been created + + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + + tutorials/index.rst + General Introduction -------------------- @@ -66,29 +84,19 @@ the radial :math:`b` to the full space. These three parameters constitute the fi For further details, see the the paper. - - - -Documentation & Tutorials -------------------------- - -For **AMBER** the following tutorials have been created - - -.. toctree:: - :maxdepth: 2 - :caption: Contents: - - - tutorials/index.rst - - Contribute ---------- +This project is more than happy for contribution to the code base. However, it is recommended that before a large commitment and/pull request is made, +please do contact the `maintainers`_ or open an `issue`_. Contact ------- +Contact to the maintainers is recommended through either an `issue`_ or by sending an email to the `maintainers`_. + +.. _maintainers: mailto:jakob.lass@psi.ch + +.. _issue: https://gitea.psi.ch/lass_j/AMBER/issues \ No newline at end of file