~andy47/simple_log commit

3 files changed, 11 insertions(+), 12 deletions(-)

M docs/source/conf.py
M docs/source/index.rst
M docs/source/simplelog.rst

M docs/source/conf.py +1 -1

@@ 53,7 53,7 @@ master_doc = 'index'
 
 # General information about the project.
 project = 'Simple Log'
-copyright = '2016, Andy Todd'
+copyright = '2017, Andrew J. Todd esq'
 author = 'Andy Todd'
 
 # The version info for the project you're documenting, acts as replacement for

M docs/source/index.rst +4 -2

@@ 1,7 1,9 @@ 
 Simple Logging
 ==============
 
-Welcome to the simple log Python module.
+Welcome to the simple log Python module. The easiest and simplest 
+way to produce good looking log messages from your Python script 
+or application.
 
 Contents:
 

          
@@ 17,4 19,4 @@ Indices and tables
 
 * :ref:`genindex`
 * :ref:`modindex`
-* :ref:`search`
  No newline at end of file
+* :ref:`search`

M docs/source/simplelog.rst +6 -9

@@ 33,10 33,9 @@ If you want to have multiple logs just p
     >>> second_log.debug("This is a debug message")
     2016.11.10 22:28:02 DEBUG:: This is a debug message
 
-By default the logging level is set to `'INFO'` (the standard module defaults to `'WARNING'`). See the
+By default the logging level is set to ``INFO`` (the standard module defaults to ``WARNING``). See the
 `logging tutorial <https://docs.python.org/3/howto/logging.html#logging-basic-tutorial>`_ for information on logging
-levels. If you would like to change the logging level, for instance to display 'DEBUG' messages use the `setLevel`
-method on your log object
+levels. If you would like to change the logging level, for instance to display ``DEBUG`` messages use the ``setLevel`` method on your log object
 
     >>> from simple_log import get_log
     >>> my_log = get_log('test_log')

          
@@ 46,7 45,7 @@ method on your log object
     >>> my_log.debug('This is the second debug message')
     2016.11.10 22:34:55 DEBUG:: This is the second debug message
 
-If you would like your log messages written to a file as well as the screen use the `add_file` function
+If you would like your log messages written to a file as well as the screen use the ``add_file`` function
 
     >>> from simple_log import get_log, add_file
     >>> my_log = get_log('test_log')

          
@@ 58,8 57,7 @@ If you would like your log messages writ
     >>> cat test_log.log
     2016.11.12 22:49:30 INFO:: This is another information message
 
-the `add_file` function tries to be clever and should work if you pass it either the name of a log that was created
-using `get_log` or if you pass in the log object itself.
+the ``add_file`` function tries to be clever and should work if you pass it either the name of a log that was created using ``get_log`` or if you pass in the log object itself.
 
     >>> from simple_log import get_log, add_file
     >>> my_log = get_log('test_log')

          
@@ 72,10 70,9 @@ using `get_log` or if you pass in the lo
 Code Structure
 --------------
 
-The only dependency for `simple_log` is the Python standard library :py:mod:`logging` module
+The only dependency for ``simple_log`` is the Python standard library :py:mod:`logging` module
 
-This package is made up of one Python module called `log_utilities.py` within the `simple_log` module. It has two
-functions
+This package is made up of one Python module called ``log_utilities.py`` within the ``simple_log`` module. It has two functions
 
 .. autofunction:: simple_log.get_log