Add pandas intersphinx mapping

docs/conf.py

@@ -12,13 +12,21 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
+import os
+import sys
+
 # 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('..'))
+
+# Insert Camelot's path into the system.
 sys.path.insert(0, os.path.abspath('..'))
 
+import camelot
+
+
 # -- General configuration ------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
@@ -53,15 +61,14 @@ source_suffix = '.rst'
 master_doc = 'index'
 
 # General information about the project.
-project = u'camelot'
-copyright = u'2016, SocialCops'
+project = u'Camelot'
+copyright = u'2018, SocialCops'
 author = u'Vinayak Mehta'
 
 # 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.
 
-import camelot
 # The short X.Y version.
 version = camelot.__version__
 # The full version, including alpha/beta/rc tags.
@@ -86,7 +93,7 @@ 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 = ['_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = ['_build']
 
 # The reST default role (used for this markup: `text`) to use for all
 # documents.
@@ -94,13 +101,11 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 # default_role = None
 
 # If true, '()' will be appended to :func: etc. cross-reference text.
-#
-# add_function_parentheses = True
+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
+add_module_names = True
 
 # If true, sectionauthor and moduleauthor directives will be shown in the
 # output. They are ignored by default.
@@ -108,7 +113,7 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 # show_authors = False
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = 'flask_theme_support.FlaskyStyle'
 
 # A list of ignored prefixes for module index sorting.
 # modindex_common_prefix = []
@@ -124,7 +129,6 @@ todo_include_todos = True
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-#
 html_theme = 'alabaster'
 
 # Theme options are theme-specific and customize the look and feel of a theme
@@ -135,7 +139,8 @@ html_theme_options = {
     'github_user': 'socialcopsdev',
     'github_repo': 'camelot',
     'github_banner': True,
-    'show_related': False
+    'show_related': False,
+    'note_bg': '#FFF59C'
 }
 
 # Add any paths that contain custom themes here, relative to this directory.
@@ -144,7 +149,7 @@ html_theme_options = {
 # The name for this set of Sphinx documents.
 # "<project> v<release> documentation" by default.
 #
-# html_title = u'camelot v0.1'
+# html_title = None
 
 # A shorter title for the navigation bar.  Default is the same as html_title.
 #
@@ -180,8 +185,7 @@ html_static_path = ['_static']
 
 # If true, SmartyPants will be used to convert quotes and dashes to
 # typographically correct entities.
-#
-# html_use_smartypants = True
+html_use_smartypants = True
 
 # Custom sidebar templates, maps document names to template names.
 #
@@ -205,16 +209,13 @@ html_static_path = ['_static']
 # html_split_index = False
 
 # If true, links to the reST sources are added to the pages.
-#
-# html_show_sourcelink = True
+html_show_sourcelink = True
 
 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
-#
-# html_show_sphinx = True
+html_show_sphinx = False
 
 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
-#
-# html_show_copyright = 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
@@ -244,7 +245,7 @@ html_static_path = ['_static']
 # html_search_scorer = 'scorer.js'
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'camelotdoc'
+htmlhelp_basename = 'Camelotdoc'
 
 # -- Options for LaTeX output ---------------------------------------------
 
@@ -270,7 +271,7 @@ latex_elements = {
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'camelot.tex', u'camelot Documentation',
+    (master_doc, 'Camelot.tex', u'Camelot Documentation',
      u'Vinayak Mehta', 'manual'),
 ]
 
@@ -312,7 +313,7 @@ latex_documents = [
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, 'camelot', u'camelot Documentation',
+    (master_doc, 'Camelot', u'Camelot Documentation',
      [author], 1)
 ]
 
@@ -327,8 +328,8 @@ man_pages = [
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'camelot', u'camelot Documentation',
-     author, 'camelot', 'One line description of project.',
+    (master_doc, 'Camelot', u'Camelot Documentation',
+     author, 'Camelot', 'One line description of project.',
      'Miscellaneous'),
 ]
 
@@ -350,4 +351,7 @@ texinfo_documents = [
 
 
 # Example configuration for intersphinx: refer to the Python standard library.
-intersphinx_mapping = {'https://docs.python.org/2': None}
+intersphinx_mapping = {
+    'python': ('https://docs.python.org/2': None),
+    'pandas': ('http://pandas.pydata.org/pandas-docs/stable': None)
+}