Updated documentation

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

src/doc/guides/hourlylogging.rst

@@ -89,7 +89,7 @@ These specify what :py:mod:`pywws.hourly` should do when it is run.
 Tasks in the ``[live]`` and ``[logged]`` sections are done when there is new logged data, tasks in the ``[hourly]`` section are done every hour, tasks in the ``[12 hourly]`` section are done twice daily and tasks in the ``[daily]`` section are done once per day.
 
 The ``plot`` and ``text`` entries are lists of template files for plots and text files to be processed.
-The ``services`` entry is a list of online weather services to upload data and files to.
+The ``services`` entry is a list of online weather services to upload data and files to, e.g. ``'underground'`` or ``('ftp', '24hrs.txt')``.
 Add the names of your template files and weather services to the appropriate entries, for example::
 
    [logged]
@@ -98,9 +98,9 @@ Add the names of your template files and weather services to the appropriate ent
    text = []
 
    [hourly]
-   services = [('twitter', 'tweet.txt'), ('ftp', '7days.png'),
-               ('ftp', '24hrs.png'), ('ftp', 'rose_24hrs.png'),
-               ('ftp', '24hrs.txt'), ('ftp', '6hrs.txt'), ('ftp', '7days.txt')]
+   services = [('twitter', 'tweet.txt'),
+               ('ftp', '7days.png', '24hrs.png', 'rose_24hrs.png',
+                       '24hrs.txt', '6hrs.txt', '7days.txt')]
    plot = ['7days.png.xml', '24hrs.png.xml', 'rose_24hrs.png.xml']
    text = ['tweet.txt', '24hrs.txt', '6hrs.txt', '7days.txt']
 
@@ -110,8 +110,7 @@ Add the names of your template files and weather services to the appropriate ent
    text = []
 
    [daily]
-   services = [('twitter', 'forecast.txt'), ('ftp', '28days.png'),
-               ('ftp', 'allmonths.txt')]
+   services = [('twitter', 'forecast.txt'), ('ftp', '28days.png', 'allmonths.txt')]
    plot = ['28days.png.xml']
    text = ['forecast.txt', 'allmonths.txt']
 

src/doc/guides/integration.rst

@@ -20,7 +20,7 @@ How to integrate pywws with various weather services
 ====================================================
 
 This guide gives brief instructions on how to use pywws with some other weather services and software.
-It is not comprehensive, and most services (such as Twitter) are covered in more detail elsewhere.
+It is not comprehensive, and most services are covered in more detail elsewhere.
 
 YoWindow
 --------
@@ -101,6 +101,10 @@ The service uploaders are all used in a similar fashion:
 
      [live]
      services = ['underground']
+
+   Note that some services, such as :py:mod:`pywws.service.copy`, need one or more parameters.
+   Instead of a single word entry, such as ``underground``, these use a bracketed list, for example ``('copy', 'yowindow.xml')``.
+
 #. Restart pywws live logging.
 
 Some of the services are more complicated to configure.

src/doc/guides/livelogging.rst

@@ -83,7 +83,7 @@ In weather.ini you should have a ``[live]`` section similar to the following::
    plot = []
 
 This section specifies what pywws should do every time it gets a new reading from the weather station, i.e. every 48 seconds.
-The ``services`` entry is a list of online weather services to upload data to, e.g. ``['underground']``.
+The ``services`` entry is a list of online weather services to upload data to, e.g. ``'underground'`` or ``('ftp', '24hrs.txt')``.
 The ``plot`` and ``text`` entries are lists of template files for plots and text files to be processed.
 You should probably leave all of these blank except for ``services``.
 
@@ -104,9 +104,9 @@ Add the names of your template files to the appropriate entries, for example::
    text = []
 
    [hourly]
-   services = [('twitter', 'tweet.txt'), ('ftp', '7days.png'),
-               ('ftp', '24hrs.png'), ('ftp', 'rose_24hrs.png'),
-               ('ftp', '24hrs.txt'), ('ftp', '6hrs.txt'), ('ftp', '7days.txt')]
+   services = [('twitter', 'tweet.txt'),
+               ('ftp', '7days.png', '24hrs.png', 'rose_24hrs.png',
+                       '24hrs.txt', '6hrs.txt', '7days.txt')]
    plot = ['7days.png.xml', '24hrs.png.xml', 'rose_24hrs.png.xml']
    text = ['tweet.txt', '24hrs.txt', '6hrs.txt', '7days.txt']
 
@@ -116,8 +116,7 @@ Add the names of your template files to the appropriate entries, for example::
    text = []
 
    [daily]
-   services = [('twitter', 'forecast.txt'), ('ftp', '28days.png'),
-               ('ftp', 'allmonths.txt')]
+   services = [('twitter', 'forecast.txt'), ('ftp', '28days.png', 'allmonths.txt')]
    plot = ['28days.png.xml']
    text = ['forecast.txt', 'allmonths.txt']
 

src/doc/guides/weather_ini.rst

@@ -134,6 +134,7 @@ live: tasks to be done every 48 seconds
 This section specifies tasks that are to be carried out for every data sample during 'live logging', i.e. every 48 seconds.
 
 ``services`` is a list of 'services' to upload data to.
+Some are just a single word, others have one or more parameters and need to be enclosed in brackets.
 Each one listed must have a module in ``pywws.service`` or your modules directory.
 See :ref:`integration - other services<guides-integration-other>` for more detail.
 pywws will automatically limit the frequency of service uploads according to each service's requirements.
@@ -152,6 +153,7 @@ logged: tasks to be done every time the station logs a data record
 This section specifies tasks that are to be carried out every time a data record is logged when 'live logging' or every time an hourly cron job is run.
 
 ``services`` is a list of 'services' to upload data to.
+Some are just a single word, others have one or more parameters and need to be enclosed in brackets.
 Each one listed must have a module in ``pywws.service`` or your modules directory.
 See :ref:`integration - other services<guides-integration-other>` for more detail.
 
@@ -209,6 +211,7 @@ hourly: tasks to be done every hour
 This section specifies tasks that are to be carried out every hour when 'live logging' or running an hourly cron job.
 
 ``services`` is a list of 'services' to upload data to.
+Some are just a single word, others have one or more parameters and need to be enclosed in brackets.
 Each one listed must have a module in ``pywws.service`` or your modules directory.
 See :ref:`integration - other services<guides-integration-other>` for more detail.
 
@@ -227,6 +230,7 @@ This section specifies tasks that are to be carried out every 12 hours when 'liv
 The tasks are done at your day end hour, and 12 hours later.
 
 ``services`` is a list of 'services' to upload data to.
+Some are just a single word, others have one or more parameters and need to be enclosed in brackets.
 Each one listed must have a module in ``pywws.service`` or your modules directory.
 See :ref:`integration - other services<guides-integration-other>` for more detail.
 
@@ -245,6 +249,7 @@ This section specifies tasks that are to be carried out every day when 'live log
 The tasks are done at your day end hour.
 
 ``services`` is a list of 'services' to upload data to.
+Some are just a single word, others have one or more parameters and need to be enclosed in brackets.
 Each one listed must have a module in ``pywws.service`` or your modules directory.
 See :ref:`integration - other services<guides-integration-other>` for more detail.
 

src/pywws/__init__.py

@@ -1,3 +1,3 @@
 __version__ = '18.9.0'
-_release = '1632'
-_commit = 'ad0d264'
+_release = '1633'
+_commit = 'a47726b'