daveoncode
diff --git a/‎README.md
Lines changed: 11 additions & 3 deletions b/‎README.md
Lines changed: 11 additions & 3 deletions
diff --git a/‎docs/conf.py
Lines changed: 10 additions & 214 deletions b/‎docs/conf.py
Lines changed: 10 additions & 214 deletions
diff --git a/‎docs/index.rst
Lines changed: 32 additions & 12 deletions b/‎docs/index.rst
Lines changed: 32 additions & 12 deletions
diff --git a/‎string_utils/errors.py
Lines changed: 6 additions & 3 deletions b/‎string_utils/errors.py
Lines changed: 6 additions & 3 deletions
@@ -34,7 +34,15 @@ The library basically consists in the python package `string_utils`, containing
 
 Plus a secondary package `tests` which includes several submodules.\
 Specifically one for each test suite and named according to the api to test (eg. tests for `is_ip()` 
-will be in `test_is_ip.py` and so on)
+will be in `test_is_ip.py` and so on).
+
+All the public API are importable directly from the main package `string_utils`, so this:
+
+`from string_utils.validation import is_ip`
+
+can be simplified as:
+ 
+ `from string_utils import is_ip`
 
 ### Api overview
 
@@ -239,9 +247,9 @@ asciify('èéùúòóäåëýñÅÀÁÇÌÍÑÓË')
 # returns 'eeuuooaaeynAAACIINOE' (string is deliberately dumb in order to show char conversion)
 ~~~~
 
-**slugify**: Convert a string into formatted slug
+**slugify**: Convert a string into a formatted "slug"
 ~~~~
-slugify('Top 10 Reasons To Love Dogs') # returns: 'top-10-reasons-to-love-dogs'
+slugify('Top 10 Reasons To Love Dogs!!!') # returns: 'top-10-reasons-to-love-dogs'
 ~~~~
 
 **booleanize**: Convert a string into a boolean based on its content
 
@@ -1,17 +1,5 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
-#
-# Python String Utils documentation build configuration file, created by
-# sphinx-quickstart on Thu Jul 30 16:08:10 2015.
-#
-# 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.
 
 import os
 import sys
@@ -21,18 +9,10 @@
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 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_rtd_theme',
-]
+extensions = ['sphinx.ext.autodoc', 'sphinx_rtd_theme']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -42,9 +22,6 @@
 # source_suffix = ['.rst', '.md']
 source_suffix = '.rst'
 
-# The encoding of source files.
-# source_encoding = 'utf-8-sig'
-
 # The master toctree document.
 master_doc = 'index'
 
@@ -53,12 +30,9 @@
 copyright = '2016-2020, Davide Zanotti'
 author = 'Davide Zanotti'
 
-# 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 = '1.0.0'
+
 # The full version, including alpha/beta/rc tags.
 release = '1.0.0'
 
@@ -69,218 +43,40 @@
 # Usually you set "language" from the command line for these cases.
 language = None
 
-# There are two options for replacing |today|: either, you set today to some
-# non-false value, then it is used:
-# today = ''
-# Else, today_fmt is used as the format for a strftime call.
-# today_fmt = '%B %d, %Y'
-
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = ['build', '.venv', '.tox', 'htmlcov']
-
-# The reST default role (used for this markup: `text`) to use for all
-# documents.
-# default_role = None
-
-# If true, '()' will be appended to :func: etc. cross-reference text.
-# add_function_parentheses = True
-
-# If true, the current module name will be prepended to all description
-# unit titles (such as .. function::).
-# add_module_names = True
-
-# If true, sectionauthor and moduleauthor directives will be shown in the
-# output. They are ignored by default.
-# show_authors = False
-
-# The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
-
-# A list of ignored prefixes for module index sorting.
-# modindex_common_prefix = []
-
-# If true, keep warnings as "system message" paragraphs in the built documents.
-# keep_warnings = False
+exclude_patterns = ['build', '_build', '_templates', '.venv', '.tox', 'htmlcov']
 
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = False
 
-# -- 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 themes here, relative to this directory.
-# html_theme_path = []
-
-# The name for this set of Sphinx documents.  If None, it defaults to
-# "<project> v<release> documentation".
-# html_title = None
-
-# A shorter title for the navigation bar.  Default is the same as html_title.
-# html_short_title = None
-
-# The name of an image file (relative to this directory) to place at the top
-# of the sidebar.
-# html_logo = None
-
-# The name of an image file (within the static path) to use as favicon of the
-# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
-# pixels large.
-# html_favicon = None
-
-# 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']
-
-# Add any extra paths that contain custom files (such as robots.txt or
-# .htaccess) here, relative to this directory. These files are copied
-# directly to the root of the documentation.
-# html_extra_path = []
-
-# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
-# using the given strftime format.
-# html_last_updated_fmt = '%b %d, %Y'
-
-# If true, SmartyPants will be used to convert quotes and dashes to
-# typographically correct entities.
-# html_use_smartypants = True
-
-# Custom sidebar templates, maps document names to template names.
-# html_sidebars = {}
-
-# Additional templates that should be rendered to pages, maps page names to
-# template names.
-# html_additional_pages = {}
-
-# If false, no module index is generated.
-# html_domain_indices = True
-
-# If false, no index is generated.
-# html_use_index = True
-
-# If true, the index is split into individual pages for each letter.
-# html_split_index = False
-
-# If true, links to the reST sources are added to the pages.
-# html_show_sourcelink = True
-
-# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
-# html_show_sphinx = True
-
-# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
-# html_show_copyright = True
-
-# If true, an OpenSearch description file will be output, and all pages will
-# contain a <link> tag referring to it.  The value of this option must be the
-# base URL from which the finished HTML is served.
-# html_use_opensearch = ''
-
-# This is the file name suffix for HTML files (e.g. ".xhtml").
-# html_file_suffix = None
-
-# Language to be used for generating the HTML full-text search index.
-# Sphinx supports the following languages:
-#   'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja'
-#   'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr'
-# html_search_language = 'en'
-
-# A dictionary with options for the search language support, empty by default.
-# Now only 'ja' uses this config value
-# html_search_options = {'type': 'default'}
-
-# The name of a javascript file (relative to the configuration directory) that
-# implements a search results scorer. If empty, the default will be used.
-# html_search_scorer = 'scorer.js'
-
-# Output file base name for HTML help builder.
-htmlhelp_basename = 'PythonStringUtilsdoc'
-
-# -- 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',
+html_theme_options = {
+    'collapse_navigation': False,
 }
 
+latex_elements = {}
+
 # 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, 'PythonStringUtils.tex', 'Python String Utils Documentation',
-     'Davide Zanotti', 'manual'),
+    (master_doc, 'PythonStringUtils.tex', 'Python String Utils Documentation', 'Davide Zanotti', 'manual'),
 ]
 
-# The name of an image file (relative to this directory) to place at the top of
-# the title page.
-# latex_logo = None
-
-# For "manual" documents, if this is true, then toplevel headings are parts,
-# not chapters.
-# latex_use_parts = False
-
-# If true, show page references after internal links.
-# latex_show_pagerefs = False
-
-# If true, show URL addresses after external links.
-# latex_show_urls = False
-
-# Documents to append as an appendix to all manuals.
-# latex_appendices = []
-
-# If false, no module index is generated.
-# latex_domain_indices = True
-
-
-# -- 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, 'pythonstringutils', 'Python String Utils Documentation',
-     [author], 1)
+    (master_doc, 'pythonstringutils', 'Python String Utils Documentation', [author], 1)
 ]
 
-# If true, show URL addresses after external links.
-# man_show_urls = False
-
-
-# -- 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, 'PythonStringUtils', 'Python String Utils Documentation',
-     author, 'PythonStringUtils', 'One line description of project.',
-     'Miscellaneous'),
+     author, 'PythonStringUtils', 'One line description of project.', 'Miscellaneous'),
 ]
-
-# Documents to append as an appendix to all manuals.
-# texinfo_appendices = []
-
-# If false, no module index is generated.
-# texinfo_domain_indices = True
-
-# How to display URL addresses: 'footnote', 'no', or 'inline'.
-# texinfo_show_urls = 'footnote'
-
-# If true, do not generate a @detailmenu in the "Top" node's menu.
-# texinfo_no_detailmenu = False
@@ -1,28 +1,48 @@
-.. Python String Utils documentation master file, created by
-   sphinx-quickstart on Thu Jul 30 16:08:10 2015.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
 Python String Utils Documentation
 =================================
 
-Contents:
-
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 3
+
+
+String Validation
+-----------------
 
 .. automodule:: string_utils.validation
    :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+String Manipulation
+-------------------
 
 .. automodule:: string_utils.manipulation
    :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+String Generation
+-----------------
 
 .. automodule:: string_utils.generation
    :members:
+   :undoc-members:
+   :show-inheritance:
+
 
-Indices and tables
-==================
+Exceptions
+----------
+
+.. automodule:: string_utils.errors
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+Indices
+=======
 
 * :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+
@@ -1,11 +1,14 @@
 # -*- coding: utf-8 -*-
+from typing import Any
 
 
 class InvalidInputError(TypeError):
-    def __init__(self, input_data):
-        """
-        Custom error used when received object is not a string as expected.
+    """
+    Custom error raised when received object is not a string as expected.
+    """
 
+    def __init__(self, input_data: Any):
+        """
         :param input_data: Any received object
         """
         type_name = type(input_data).__name__