Repository: DistrictDataLabs/yellowbrick

Issue:
Add Sphinx autodoc and intersphinx
Add sphinx autodoc and intersphinx to pull docstrings into documentation.

Add Sphinx autodoc and intersphinx
Add sphinx autodoc and intersphinx to pull docstrings into documentation.



Discussion:
Planning on moving all the documentation over to reStructuredText and Sphinx?

Yes

Sent from my iPhone

> On Jun 25, 2016, at 4:41 PM, Benjamin Bengfort notifications@github.com wrote:
> 
> Planning on moving all the documentation over to reStructuredText and Sphinx?
> 
> —
> You are receiving this because you were assigned.
> Reply to this email directly, view it on GitHub, or mute the thread.

Planning on moving all the documentation over to reStructuredText and Sphinx?

Yes

Sent from my iPhone

> On Jun 25, 2016, at 4:41 PM, Benjamin Bengfort notifications@github.com wrote:
> 
> Planning on moving all the documentation over to reStructuredText and Sphinx?
> 
> —
> You are receiving this because you were assigned.
> Reply to this email directly, view it on GitHub, or mute the thread.


Resolving patch:
diff --git a/docs/conf.py b/docs/conf.py
new file mode 100644
--- /dev/null
+++ b/docs/conf.py
@@ -0,0 +1,348 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# yellowbrick documentation build configuration file, created by
+# sphinx-quickstart on Tue Jul  5 19:45:43 2016.
+#
+# 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.intersphinx',
+    'sphinx.ext.coverage',
+    'sphinx.ext.mathjax',
+    'sphinx.ext.viewcode',
+]
+
+# 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 encoding of source files.
+#
+# source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = 'yellowbrick'
+copyright = '2016, District Data Labs'
+author = 'District Data Labs'
+
+# 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'
+# The full version, including alpha/beta/rc tags.
+release = '0.1'
+
+# 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
+
+# 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.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# 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
+
+# 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.
+# "<project> v<release> documentation" by default.
+#
+# html_title = 'yellowbrick v0.1'
+
+# 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 (relative to this directory) to use as a 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 None, a 'Last updated on:' timestamp is inserted at every page
+# bottom, using the given strftime format.
+# The empty string is equivalent to '%b %d, %Y'.
+#
+# html_last_updated_fmt = None
+
+# 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', 'zh'
+#
+# html_search_language = 'en'
+
+# A dictionary with options for the search language support, empty by default.
+# 'ja' uses this config value.
+# 'zh' user can custom change `jieba` dictionary path.
+#
+# 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 = 'yellowbrickdoc'
+
+# -- 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, 'yellowbrick.tex', 'yellowbrick Documentation',
+     'District Data Labs', '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, 'yellowbrick', 'yellowbrick 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, 'yellowbrick', 'yellowbrick Documentation',
+     author, 'yellowbrick', '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
+
+
+# Locations of objects.inv files for intersphinx extension that auto links to external api docs.
+intersphinx_mapping = {'python': ('https://docs.python.org/3', None),
+                       'matplotlib': ('http://matplotlib.org/', None),
+                       'scipy': ('http://scipy.github.io/devdocs/', None),
+                       'numpy': ('https://docs.scipy.org/doc/numpy-dev/', None),
+                       'cycler': ('http://matplotlib.org/cycler/', None),
+                       'seaborn': ('https://web.stanford.edu/~mwaskom/software/seaborn/', None)}
diff --git a/yellowbrick/yb_palettes.py b/yellowbrick/yb_palettes.py
--- a/yellowbrick/yb_palettes.py
+++ b/yellowbrick/yb_palettes.py
@@ -86,40 +86,58 @@ def as_hex(self):
 
 def color_palette(palette=None, n_colors=None, desat=None):
     """Return a list of colors defining a color palette.
-    Availible seaborn palette names:
-        accent, dark, paired, pastel, bold, muted
-    Availible seaborn palette names:
-        sns_deep, sns_muted, sns_bright, sns_pastel, sns_dark, sns_colorblind
-    Other options:
-        list of colors
     Calling this function with ``palette=None`` will return the current
     matplotlib color cycle.
     This function can also be used in a ``with`` statement to temporarily
     set the color cycle for a plot or set of plots.
-    Parameters
-    ----------
-    palette: None, string, or sequence, optional
+
+    :param palette:
         Name of palette or None to return current palette. If a sequence, input
         colors are used but possibly cycled and desaturated.
-    n_colors : int, optional
+
+        Available seaborn palette names from :py:mod:`seaborn.palettes` are:
+
+        .. hlist::
+            :columns: 3
+
+            * :py:const:`deep`
+            * :py:const:`dark`
+            * :py:const:`paired`
+            * :py:const:`pastel`
+            * :py:const:`bold`
+            * :py:const:`muted`
+            * :py:const:`sns_deep`
+            * :py:const:`sns_muted`
+            * :py:const:`sns_bright`
+            * :py:const:`sns_pastel`
+            * :py:const:`sns_dark`
+            * :py:const:`sns_colorblind`
+
+    :type palette: None or str or sequence
+    :param n_colors:
         Number of colors in the palette. If ``None``, the default will depend
         on how ``palette`` is specified. Named palettes default to 6 colors
         (except paired, which has 10),
         but grabbing the current palette or passing in a list of colors will
         not change the number of colors unless this is specified. Asking for
         more colors than exist in the palette will cause it to cycle.
+    :type n_colors: int or None
+    :param desat:
+    :type desat:
 
-    Returns
-    -------
-    palette : list of RGB tuples.
+    :rtype: list(tuple)
+    :return: list of RGB tuples.
         Color palette. Behaves like a list, but can be used as a context
-        manager and possesses an ``as_hex`` method to convert to hex color
+        manager and possesses an :py:meth:`as_hex` method to convert to hex color
         codes.
-    See Also
-    --------
-    set_palette : Set the default color cycle for all plots.
-    set_color_codes : Reassign color codes like ``"b"``, ``"g"``, etc. to
-                      colors from one of the yellowbrick palettes.
+
+    .. seealso::
+
+        :func:`.set_palette`
+            Set the default color cycle for all plots.
+        :func:`.set_color_codes`
+            Reassign color codes like ``"b"``, ``"g"``, etc. to
+            colors from one of the yellowbrick palettes.
     """
     if palette is None:
         palette = get_color_cycle()


Test patch: