Documentation tweaks

Signed-off-by: Jim Easterbrook <jim@jim-easterbrook.me.uk>

src/contributors/contributors.txt

@@ -9,11 +9,11 @@ Rod Persky
 Morten Høybye Frederiksen       morten@mfd-consult.dk
 Simon Josefsson                 simon@josefsson.org
 Matthew Hilton                  matthilton2005@gmail.com
-Sabine Tobolka			            oe1yvw@gmail.com
+Sabine Tobolka                  oe1yvw@gmail.com
 Markus Birth                    markus@birth-online.de
 Chris Ramsay                    chris@ramsay-family.net
 Christian Benke                 benkokakao@gmail.com
-Ian Wilkinson			null@sgtwilko.f9.co.uk
+Ian Wilkinson                   null@sgtwilko.f9.co.uk
 
 Translators
 -----------

src/doc/conf.py

@@ -67,6 +67,8 @@
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
+highlight_language = 'none'
+
 rst_epilog = """
 ----
 

src/doc/guides/getstarted.rst

@@ -336,6 +336,7 @@ Open this with a text editor. You should find something like the following::
 Re-ordering them has no effect.)
 You need to add a new entry in the ``[config]`` section called ``day end hour``.
 This tells pywws what convention you want to use when calculating daily summary data.
+The entry should have two values separated by a comma: a number in the range 0 to 23 (the hour of day, in local winter time) and a single word ``True`` or ``False`` to say if the day end should adjust with summer (daylight savings) time.
 In the UK, the 'meteorological day' is usually from 09:00 to 09:00 GMT (10:00 to 10:00 BST during summer), so I use a day end hour value of ``9, False``.
 If you prefer to use midnight, winter or summer, you should use ``0, True``.
 

src/doc/guides/integration.rst

@@ -117,6 +117,6 @@ Your module's ``upload_data`` method must return a ``(bool, str)`` tuple where t
 (If the server returns no message this string should be set to ``'OK'``.)
 Under normal operation pywws will log this message whenever it changes.
 
-Once your uploader is working OK you could contribute it to pywws if it's likely to be useful to other people.
+Once your uploader is working you could contribute it to pywws if it's likely to be useful to other people.
 Don't forget to document it fully, then either send it to Jim or create a GitHub pull request.
 See :ref:`copyright-contributing` for instructions on doing this.

src/doc/guides/logfiles.rst

@@ -149,7 +149,7 @@ Clock drift
    2018-05-28 11:59:14:pywws.weatherstation:station clock drift -0.297843 -0.375514
 
 These lines report how the weather station's internal ("station") and external ("sensor") clocks are drifting with respect to the computer's clock.
-These measurements are used to avoid accessing the station's USB port at the same time as it is receiving data or logging data, as this is known to cause some station's USB ports to become inaccessible.
+These measurements are used to avoid accessing the station's USB port at the same time as it is receiving data or logging data, as this is known to cause some stations' USB ports to become inaccessible.
 The two "drift" figures are the current value (only accurate to about 1 second) and the long term average.
 You should ensure that the ``usb activity margin`` value in your :ref:`weather.ini file <weather_ini-config>` is at least 0.5 seconds greater than the absolute value of the long term drift of each clock.
 Note that these drift values change with temperature.
@@ -232,12 +232,10 @@ Live data missed
 ----------------
 
 .. code-block:: none
-   :linenos:
 
    2015-10-30 04:49:56:pywws.weatherstation:live_data missed
 
-Line 3 indicate that pywws failed to capture live data.
-
+Sometimes pywws fails to capture live data.
 This happens if a new data record is identical to the previous one so pywws doesn't detect a change.
 This is unlikely to happen if you are receiving wind data properly.
 

src/pywws/__init__.py

@@ -1,3 +1,3 @@
 __version__ = '18.6.0'
-_release = '1549'
-_commit = 'ca9d3ec'
+_release = '1550'
+_commit = '06f4f72'

src/pywws/calib.py

@@ -18,7 +18,6 @@
 
 """
 Calibrate raw weather station data
-==================================
 
 This module allows adjustment of raw data from the weather station as
 part of the 'processing' step (see :doc:`pywws.process`). For example,
@@ -38,7 +37,9 @@
 
 You could start by copying one of the example calibration modules, or
 you can create a plain text file in your ``modules`` directory, e.g.
-``calib.py`` and copy the following text into it::
+``calib.py`` and copy the following text into it:
+
+.. code-block:: python3
 
     class Calib(object):
         def __init__(self, params, stored_data):

src/pywws/mergeewdata.py

@@ -24,7 +24,7 @@
 Introduction
 ------------
 
-This modlue converts data from the format used by the EasyWeather
+This module converts data from the format used by the EasyWeather
 program supplied with the weather station to the format used by pywws.
 It is useful if you've been using EasyWeather for a while before
 discovering pywws.

src/pywws/process.py

@@ -36,15 +36,15 @@
 The daily data summarises the weather over a 24 hour period typically
 ending at 2100 or 0900 hours, local (non DST) time, though midnight is
 another popular convention. It is also indexed by the last complete
-record in the period. Daytime and nightime, as used when computing
+record in the period. Daytime and nighttime, as used when computing
 maximum and minimum temperatures, are assumed to start at 0900 and
 2100 local time, or 1000 and 2200 when DST is in effect, regardless of
 the meteorological day.
 
 To adjust the meteorological day to your preference, or that used by
 your local official weather station, edit the "day end hour" line in
-your ``weather.ini`` file, then run pywws.reprocess to regenerate the
-summaries.
+your ``weather.ini`` file, then run :mod:`pywws.reprocess` to regenerate
+the summaries.
 
 Monthly summary data is computed from the daily summary data. If the
 meteorological day does not end at midnight, then each month may begin

src/pywws/windrose.py

@@ -62,7 +62,7 @@
 |            yrange_
 |            points_
 |            source_
-|            :ref:`title <plot-title>`
+|            :ref:`title <rose-title>`
 |            command_
 |        start_
 |        stop_
@@ -71,7 +71,7 @@
 |        size_
 |        fileformat_
 |        `lmargin, rmargin, tmargin, bmargin`_
-|        :ref:`title <graph-title>`
+|        :ref:`title <roses-title>`
 
 graph
 ^^^^^
@@ -138,7 +138,7 @@
 ``<lmargin>1.3</lmargin>``. Some experimentation may be necessary to
 find the best values.
 
-.. _graph-title:
+.. _roses-title:
 
 title
 ^^^^^
@@ -224,7 +224,7 @@
 is raw. Note that the different sources have different data
 dictionaries, so this choice affects ycalc.
 
-.. _plot-title:
+.. _rose-title:
 
 title
 ^^^^^