added build instructions for documentation

README.md

@@ -3,7 +3,7 @@ Sensospot Data Parser
 
 Parsing the numerical output from [SensoSpot][sensospot] microarray analysis.
 
-The [SensoSpot][sensospot] microarray analyzer is an automated fluorescence microscope with an image analysis software for detecting and measuring microarrays. The original name of the product was "FLAIR" by the company Sensovation, that was later acquired by Miltenyi. 
+The [SensoSpot][sensospot] microarray analyzer is an automated fluorescence microscope with an image analysis software for detecting and measuring microarrays. The original name of the product was "FLAIR" by the company Sensovation, that was later acquired by Miltenyi.
 
 There is no affiliation on my side regarding Sensovation or Miltenyi, I just use the product and needed a way to make the data available for further analysis.
 
@@ -18,13 +18,13 @@ There is no affiliation on my side regarding Sensovation or Miltenyi, I just use
     raw_data = sensospot_parser.parse_folder(<path to results directory>)
 
     sorted(raw_data.columns) == [
-        'Analysis.Name', 
+        'Analysis.Name',
-        'Bkg.Area', 'Bkg.Mean', 'Bkg.Median', 'Bkg.StdDev', 'Bkg.Sum', 
+        'Bkg.Area', 'Bkg.Mean', 'Bkg.Median', 'Bkg.StdDev', 'Bkg.Sum',
-        'Exposure.Id', 
+        'Exposure.Id',
-        'Parameters.Channel', 'Parameters.Time', 
+        'Parameters.Channel', 'Parameters.Time',
-        'Pos.Id', 'Pos.Nom.X', 'Pos.Nom.Y', 'Pos.X', 'Pos.Y', 
+        'Pos.Id', 'Pos.Nom.X', 'Pos.Nom.Y', 'Pos.X', 'Pos.Y',
-        'Spot.Area', 'Spot.Diameter', 'Spot.Found', 'Spot.Mean', 'Spot.Median', 
+        'Spot.Area', 'Spot.Diameter', 'Spot.Found', 'Spot.Mean', 'Spot.Median',
-        'Spot.Saturation', 'Spot.StdDev', 'Spot.Sum', 
+        'Spot.Saturation', 'Spot.StdDev', 'Spot.Sum',
         'Well.Column', 'Well.Name', 'Well.Row'
     ]
 ```
@@ -44,8 +44,8 @@ There is a `columns` module available, providing constans that define the column
 ## Avaliable public functions:
 
  - **parse_folder(path_to_folder)**
-   Searches the folder for parsable Sensospot .csv files, parses them into one 
+   Searches the folder for parsable Sensospot .csv files, parses them into one
-   big pandas data frame and will add additional meta data from parameters folder, 
+   big pandas data frame and will add additional meta data from parameters folder,
    if it is present.
 - **parse_file(path_to_csv_file)**
    Parses a Sensospot csv file into a pandas data frame and will add some additional
@@ -81,5 +81,7 @@ To install the development version of Sensovation Data Parser:
 
 To run the tests, use `make tests` (failing on first error) or `make coverage` for a complete report.
 
+To generate the documentation pages use `make docs` or `make serve-docs` for
+starting a webserver with the generated documentation
 
-[sensospot]: https://www.miltenyi-imaging.com/products/sensospot
+[sensospot]: https://www.miltenyi-imaging.com/products/sensospot