900/docs

RELEASE.txt

@@ -1,4 +1,4 @@
-SLS Detector Package Major Release 9.0.0 released on 22.11.2024
+SLS Detector Package Major Release 9.0.0 released on 25.11.2024
 ===============================================================
 
 This document describes the differences between v9.0.0 and v8.0.2
@@ -136,6 +136,15 @@ This document describes the differences between v9.0.0 and v8.0.2
 ================================
 
 
+    Compilation
+    -----------
+
+
+    *   cmake_source_dir
+        Fixed compilation error when using python and adding the slsDetectorPackage 
+        as a subfolder due to cmake source directory changing.
+
+
     Client
     ------
 

docs/CMakeLists.txt

@@ -64,7 +64,6 @@ set(SPHINX_SOURCE_FILES
   src/binaryfileformat.rst
   src/hdf5fileformat.rst
   src/zmqjsonheaderformat.rst
-  src/ctbframeformat.rst
 )
 
 foreach(filename ${SPHINX_SOURCE_FILES})

docs/src/dependencies.rst

@@ -20,7 +20,7 @@ the shared libraries these are needed:
 Python bindings
 -----------------------
 
- * Python > 3.8
+ * Python >= 3.8
  * pybind11 2.13.6 (packaged in libs)
 
 .. note ::  

docs/src/index.rst

@@ -12,7 +12,7 @@ Welcome to slsDetectorPackage's documentation!
     For further documentation, visit the official page: https://www.psi.ch/en/detectors/documentation
 
 .. toctree::
-    :maxdepth: 1
+    :maxdepth: 3
     :caption: Installation:
 
     installation
@@ -88,7 +88,6 @@ Welcome to slsDetectorPackage's documentation!
 
     fileformat
     slsreceiverheaderformat
-    ctbframeformat
     masterfileattributes
     binaryfileformat
     hdf5fileformat

docs/src/installation.rst

@@ -1,18 +1,23 @@
+
+
+.. _Installation:
+
+
+Installation
+===============
+
+One can either install pre-built binaries using conda or build from source.
+
 .. warning ::
 
     Before building from source make sure that you have the 
     :doc:`dependencies <../dependencies>` installed. If installing using conda, conda will 
     manage the dependencies. Avoid also installing packages with pip. 
 
 
-.. _Installation:
-
-
-Installation
-===============
 
 Install binaries using conda
--------------------------------
+----------------------------------
 
 Conda is not only useful to manage python environments but can also
 be used as a user space package manager. Dates in the tag (for eg. 2020.07.23.dev0) 
@@ -55,7 +60,7 @@ We have three different packages available:
 
 
 Build from source
--------------------
+----------------------
 
 1. Download Source Code from github
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -75,8 +80,10 @@ Build from source
 2. Build from Source
 ^^^^^^^^^^^^^^^^^^^^^^^^^^
 
+One can either build using cmake or use the in-built cmk.sh script.
+
 Build using CMake
-^^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 .. code-block:: bash
 
@@ -123,7 +130,7 @@ Example cmake options               Comment
 
 
 Build using in-built cmk.sh script
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 
 .. code-block:: bash
@@ -173,7 +180,7 @@ Build using in-built cmk.sh script
 
 
 Build on old distributions
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 If your linux distribution doesn't come with a C++11 compiler (gcc>4.8) then 
 it's possible to install a newer gcc using conda and build the slsDetectorPackage
@@ -198,7 +205,7 @@ using this compiler
 
 
 Build slsDetectorGui (Qt5)
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 1. Using pre-built binary on conda
 
@@ -259,7 +266,7 @@ Build slsDetectorGui (Qt5)
 
 
 Build this documentation
-^^^^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 The documentation for the slsDetectorPackage is build using a combination 
 of Doxygen, Sphinx and Breathe. The easiest way to install the dependencies
@@ -282,7 +289,7 @@ is to use conda
 
 
 Pybind and Zeromq
-^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 .. _pybind for different slsDetectorPackage versions: