doc: add silx-view.gif

- to README.rst - to silx view doc - 'vignette' to the main page
silx-kit · Dec 2, 2021 · 047b2a7 · 047b2a7
1 parent 138ad9e
commit 047b2a7
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 2 deletions.
diff --git a/README.rst b/README.rst
@@ -2,6 +2,9 @@
 silx toolkit
 ============
 
+.. |silxView| image:: http://www.silx.org/doc/silx/img/silx-view-v1-0.gif
+   :height: 480px
+
 The purpose of the *silx* project is to provide a collection of Python packages to support the
 development of data assessment, reduction and analysis applications at synchrotron
 radiation facilities.
@@ -29,8 +32,12 @@ The current version features:
 * a set of applications:
 
   * a unified viewer (*silx view filename*) for HDF5, SPEC and image file formats
+
+    |silxView|
+
   * a unified converter to HDF5 format (*silx convert filename*)
 
+
 Installation
 ------------
 

diff --git a/doc/source/applications/view.rst b/doc/source/applications/view.rst
@@ -1,7 +1,11 @@
+.. _silx view:
 
 silx view
 =========
 
+.. figure:: http://www.silx.org/doc/silx/img/silx-view-v1-0.gif
+   :align: center
+
 Purpose
 -------
 

diff --git a/doc/source/index.rst b/doc/source/index.rst
@@ -1,6 +1,9 @@
 silx |version|
 ==============
 
+.. |silxView| image:: http://www.silx.org/doc/silx/img/silx-view-v1-0.gif
+   :height: 80px
+
 The silx project aims to provide a collection of Python packages to support the
 development of data assessment, reduction and analysis at synchrotron radiation
 facilities.
@@ -28,9 +31,11 @@ The current version (v\ |version|) caters for:
 
 * a set of applications:
 
-  * a unified viewer (*silx view filename*) for HDF5, SPEC and image file formats
-  * a unified converter to HDF5 format (*silx convert filename*)
+    * a unified viewer (:ref:`silx view` *filename*) for HDF5, SPEC and image file formats
+      |silxView|
+    * a unified converter to HDF5 format (*silx convert filename*)
 
+
 
 .. toctree::
    :hidden: