added docs

.gitignore

@@ -8,7 +8,6 @@ __pycache__/
 
 # Distribution / packaging
 .Python
-env/
 build/
 develop-eggs/
 dist/
@@ -20,6 +19,7 @@ lib64/
 parts/
 sdist/
 var/
+wheels/
 *.egg-info/
 .installed.cfg
 *.egg
@@ -42,7 +42,7 @@ htmlcov/
 .cache
 nosetests.xml
 coverage.xml
-*,cover
+*.cover
 .hypothesis/
 
 # Translations
@@ -66,7 +66,7 @@ docs/_build/
 # PyBuilder
 target/
 
-# IPython Notebook
+# Jupyter Notebook
 .ipynb_checkpoints
 
 # pyenv
@@ -75,15 +75,25 @@ target/
 # celery beat schedule file
 celerybeat-schedule
 
-# dotenv
-.env
+# SageMath parsed files
+*.sage.py
 
-# virtualenv
+# Environments
+.env
+.venv
+env/
 venv/
 ENV/
 
 # Spyder project settings
 .spyderproject
+.spyproject
 
 # Rope project settings
 .ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/

Makefile

@@ -0,0 +1,17 @@
+.DEFAULT_GOAL := help
+SHELL := /bin/bash
+
+help:                ## Show available options with this Makefile
+	@fgrep -h "##" $(MAKEFILE_LIST) | fgrep -v fgrep | sed -e 's/\\$$//' | sed -e 's/##//'
+
+.PHONY: install_doc_deps
+install_doc_deps:    ## Install sphinx dependencies
+install_doc_deps:
+	@pip install sphinx sphinx_rtd_theme
+
+.PHONY: docs
+docs:                ## Generate all the docs
+docs:    install_doc_deps
+	@cd docs && sphinx-apidoc -f -o source/ ../pylogging && make html
+	@echo "docs are generated in docs/build/html/index.html"
+	@xdg-open docs/build/html/index.html

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = python -msphinx
+SPHINXPROJ    = pylogging
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/source/conf.py

@@ -0,0 +1,180 @@
+# !/usr/bin/env python
+# -*- coding: utf-8 -*-
+"""Configuration for sphinx."""
+# pylogging documentation build configuration file, created by
+# sphinx-quickstart on Thu Jun  8 22:45:18 2017.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import os
+import sys
+sys.path.insert(0, os.path.abspath('../../'))
+
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = ['sphinx.ext.autodoc',
+              'sphinx.ext.doctest',
+              'sphinx.ext.intersphinx',
+              'sphinx.ext.todo',
+              'sphinx.ext.coverage',
+              'sphinx.ext.mathjax',
+              'sphinx.ext.ifconfig',
+              'sphinx.ext.viewcode',
+              'sphinx.ext.napoleon']
+
+napoleon_google_docstring = True
+napoleon_numpy_docstring = True
+napoleon_include_init_with_doc = False
+napoleon_include_private_with_doc = False
+napoleon_include_special_with_doc = False
+napoleon_use_admonition_for_examples = False
+napoleon_use_admonition_for_notes = False
+napoleon_use_admonition_for_references = False
+napoleon_use_ivar = False
+napoleon_use_param = True
+napoleon_use_rtype = True
+napoleon_use_keyword = True
+
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = 'pylogging'
+copyright = '2017, Ankur Srivastava'
+author = 'Ankur Srivastava'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '0.1.0'
+# The full version, including alpha/beta/rc tags.
+release = '0.1.0'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = []
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = True
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'sphinx_rtd_theme'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'pyloggingdoc'
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'pylogging.tex', 'pylogging Documentation',
+     'Ankur Srivastava', 'manual'),
+]
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'pylogging', 'pylogging Documentation',
+     [author], 1)
+]
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'pylogging', 'pylogging Documentation',
+     author, 'pylogging', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {'https://docs.python.org/': None}

docs/source/index.rst

@@ -0,0 +1,20 @@
+.. pylogging documentation master file, created by
+   sphinx-quickstart on Thu Jun  8 22:45:18 2017.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to pylogging's documentation!
+=====================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/source/modules.rst

@@ -0,0 +1,7 @@
+pylogging
+=========
+
+.. toctree::
+   :maxdepth: 4
+
+   pylogging

docs/source/pylogging.rst

@@ -0,0 +1,46 @@
+pylogging package
+=================
+
+Submodules
+----------
+
+pylogging\.create\_logger module
+--------------------------------
+
+.. automodule:: pylogging.create_logger
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pylogging\.elogger module
+-------------------------
+
+.. automodule:: pylogging.elogger
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pylogging\.handler\_types module
+--------------------------------
+
+.. automodule:: pylogging.handler_types
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pylogging\.log\_levels module
+-----------------------------
+
+.. automodule:: pylogging.log_levels
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: pylogging
+    :members:
+    :undoc-members:
+    :show-inheritance:

pylogging/create_logger.py

@@ -93,21 +93,21 @@ def setup_logger(log_directory='.',
     """Set up the global logging settings.
 
     Args:
-        log_directory:str          directory to write log files to. Applicable only when `allow_file_logging` = True
-        file_handler_type:         object of logging handler from HandlerType class. Applicable only when `allow_file_logging` = True
-        allow_console_logging:bool Turn off/on the console logging.
-        allow_file_logging:bool    Turn off/on if logs need to go in files as well.
-        backup_count:int           Number of files to backup before rotating the logs.
-        max_file_size_bytes:int    Size of file in bytes before rotating the file. Applicable only to ROTATING_FILE_HANDLER.
-        when_to_rotate:str         Duration after which a file can be rotated. Applicable only to TIME_ROTATING_FILE_HANDLER
+        log_directory (str)          :Directory to write log files to. Applicable only when `allow_file_logging` = True
+        file_handler_type:           :object of logging handler from HandlerType class. Applicable only when `allow_file_logging` = True
+        allow_console_logging (bool) :Turn off/on the console logging.
+        allow_file_logging (bool)    :Turn off/on if logs need to go in files as well.
+        backup_count (int)           :Number of files to backup before rotating the logs.
+        max_file_size_bytes (int)    :Size of file in bytes before rotating the file. Applicable only to ROTATING_FILE_HANDLER.
+        when_to_rotate (str)         :Duration after which a file can be rotated. Applicable only to TIME_ROTATING_FILE_HANDLER
                                    Accepts following values:
                                     'S'	Seconds
                                     'M'	Minutes
                                     'H'	Hours
                                     'D'	Days
                                     'W0'-'W6'	Weekday (0=Monday)
                                     'midnight'	Roll over at midnight
-        change_log_level:dict      A dictionary of handlers with corresponding log-level ( for eg. {'requests':'warning'} )
+        change_log_level (dict)      :A dictionary of handlers with corresponding log-level ( for eg. {'requests':'warning'} )
     """
     if file_handler_type not in [HandlerType.ROTATING_FILE_HANDLER,
                                  HandlerType.TIME_ROTATING_FILE_HANDLER]: