Merge pull request #19 from decarlof/master

added docs for config

dmagic/config.py

@@ -7,6 +7,15 @@
 from collections import OrderedDict
 from dmagic import log
 
+__author__ = "Francesco De Carlo"
+__copyright__ = "Copyright (c) 2015-2016, UChicago Argonne, LLC."
+__docformat__ = 'restructuredtext en'
+__all__ = ['config_to_list',
+           'get_config_name',
+           'log_values',
+           'parse_known_args',
+           'write']
+
 CONFIG_FILE_NAME = os.path.join(str(pathlib.Path.home()), 'dmagic.conf')
 
 SECTIONS = OrderedDict()

dmagic/pv.py

@@ -98,7 +98,7 @@ def update(args, date=None):
 
     Parameters
     ----------
-    args : parametars passed at the CLI 
+    args : parameters passed at the CLI, see config.py for full options
     """
 
     auth      = scheduling.authorize()

docs/source/api.rst

@@ -8,6 +8,7 @@ for `DMagic <https://github.com/decarlof/DMagic>`_.
 
 .. toctree::
 
+   api/dmagic.config
    api/dmagic.pv
    api/dmagic.scheduling
    api/dmagic.utils

docs/source/api/dmagic.config.rst

@@ -0,0 +1,17 @@
+:mod:`dmagic.config`
+====================
+
+.. automodule:: dmagic.config
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+   .. rubric:: **Functions:**
+
+   .. autosummary::
+
+      config_to_list
+      get_config_name
+      log_values
+      parse_known_args
+      write