Doc clean-up

doc/index.rst

@@ -6,7 +6,8 @@
 Nabu |version|
 ==============
 
-Welcome to Nabu documentation.
+Nabu is a tomography software used at the `European Synchrotron <https://www.esrf.eu>`_.
+
 
 Quick links:
 
@@ -32,6 +33,7 @@ Features
 .. toctree::
    :maxdepth: 1
 
+   features.md
    ccdprocessing.md
    phase.md   
    distribution.md

doc/quickstart.md

@@ -9,7 +9,7 @@ To create a configuration file from scratch, you can use
 nabu-config --bootstrap
 ```
 
-More options are available, see `nabu-config --help`.
+It will create a file named `nabu.conf` with pre-filled values. More options are available, see `nabu-config --help`.
 
 ## Run the reconstruction
 
@@ -19,7 +19,8 @@ Once you filled-in the configuration, just run
 nabu nabu.conf
 ```
 
-More options are available, see `nabu --help`. For example, to reconstruct slices 1000 to 1100: `nabu nabu.conf --slice 1000-1100`
+More options are available, see `nabu --help`.  
+For example, to reconstruct slices 1000 to 1100: `nabu nabu.conf --slice 1000-1100`
 
 ## See also
 

nabu/app/component.py

@@ -75,8 +75,8 @@ class Component:
     Important
     ----------
     There are two important assumptions for components:
-      - The first argument `execute()` is an array.
-      - The ONLY output of `execute()` is an array
+       - The first argument `execute()` is an array.
+       - The ONLY output of `execute()` is an array
 
     Notes
     ------

nabu/preproc/ccd.py

@@ -298,14 +298,14 @@ class CCDCorrection(CCDProcessing):
         median_clip_thresh: float, optional
             Threshold for the median clipping method.
 
-        CCD corrections
-        ----------------
+        Notes
+        ------
         A CCD correction is a process (usually filtering) taking place in the
         radios space.
         Available filters:
-          - median_clip: if the value of the current pixel exceeds the median
-            of adjacent pixels (a 3x3 neighborhood) more than a threshold,
-            then this pixel value is set to the median value.
+           - median_clip: if the value of the current pixel exceeds the median
+             of adjacent pixels (a 3x3 neighborhood) more than a threshold,
+             then this pixel value is set to the median value.
         """
         super().__init__(radios_shape)
         check_supported(