automatic documentation

Author: germanattanasio

.travis.yml

@@ -1,19 +1,27 @@
 language: python
+sudo: false
+notifications:
+  email: false
 python:
 - '2.7'
 - '3.2'
 - '3.3'
 - '3.4'
 - '3.5'
 - 3.5-dev
+before_install:
+  - '[ "${TRAVIS_PULL_REQUEST}" = "false" ] && openssl aes-256-cbc -K $encrypted_c3e85137836d_key
+  -iv $encrypted_c3e85137836d_iv -in .env.enc -out .env -d || true'
 install:
 - pip install -r requirements-dev.txt
 - pip install pylint
+- pip install codecov
 - pip install git+git://github.com/watson-developer-cloud/python-sdk.git#egg=watson-developer-cloud
+
 script:
-- sh pylint.sh
-- coverage run --source=watson_developer_cloud setup.py test
-after_success: coveralls
-before_install:
-- openssl aes-256-cbc -K $encrypted_c3e85137836d_key -iv $encrypted_c3e85137836d_iv
-  -in .env.enc -out .env -d
+  - sh pylint.sh
+  - py.test test --cov=test
+after_success:
+  - codecov
+  - docs/publish.sh
+

docs/Makefile

@@ -4,6 +4,7 @@
 # You can set these variables from the command line.
 SPHINXOPTS    =
 SPHINXBUILD   = sphinx-build
+SPHINXAPIDOC  = sphinx-apidoc
 PAPER         =
 BUILDDIR      = _build
 
@@ -23,6 +24,7 @@ I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
 
 help:
 	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  document   to make documentation"
 	@echo "  html       to make standalone HTML files"
 	@echo "  dirhtml    to make HTML files named index.html in directories"
 	@echo "  singlehtml to make a single large HTML file"
@@ -51,6 +53,13 @@ help:
 clean:
 	rm -rf $(BUILDDIR)/*
 
+document:
+	rm -rf apis
+	$(SPHINXAPIDOC) -o apis ../watson_developer_cloud -f -e -T
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
 html:
 	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
 	@echo

docs/_static/favicon.ico

@@ -0,0 +1,7 @@
+<h3>Useful Links</h3>
+<ul>
+  <li><a href="https://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/">Watson APIs</a></li>
+  <li><a href="http://github.com/watson-developer-cloud/python-sdk">GitHub</a></li>
+  <li><a href="http://github.com/watson-developer-cloud/python-sdk/issues">Issue Tracker</a></li>
+  <li><a href="http://stackoverflow.com/questions/ask?tags=ibm-watson">StackOverflow</a></li>
+</ul>

docs/_templates/sidebarintro.html

@@ -1,40 +1,15 @@
 # -*- coding: utf-8 -*-
-#
-# Watson Developer Cloud Python SDK documentation build configuration file, created by
-# sphinx-quickstart on Fri Oct  9 00:12:27 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 sys
 import os
-import shlex
-
-sys.path.insert(0, os.path.abspath('..'))
 import watson_developer_cloud
-import os, shutil, glob
-
-import shutil
-shutil.copy2('../README.md', './index.md')
-
 
+sys.path.insert(0, os.path.abspath('../watson_developer_cloud/'))
 
 from recommonmark.parser import CommonMarkParser
 source_parsers = {
     '.md': CommonMarkParser
 }
-source_suffix = ['.rst', '.md']
-
-# 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.
-#sys.path.insert(0, os.path.abspath('.'))
 
 # -- General configuration ------------------------------------------------
 
@@ -46,22 +21,21 @@
 # ones.
 extensions = [
     'sphinx.ext.autodoc',
-    'sphinx.ext.autosummary',
-    'sphinx.ext.doctest',
-    'sphinx.ext.mathjax',
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.ifconfig',
     'sphinx.ext.viewcode',
+    'sphinx.ext.napoleon'
 ]
 
+autodoc_default_flags = ['members', 'undoc-members', 'no-show-inheritance']
+autodoc_member_order = 'bysource'
+
 # 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 = '.md'
-
-# The encoding of source files.
-#source_encoding = 'utf-8-sig'
+source_suffix = ['.rst', '.md']
 
 # The master toctree document.
 master_doc = 'index'
@@ -71,42 +45,26 @@
 copyright = u'2015, IBM Corp'
 author = u'IBM Corp'
 
-# 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 = watson_developer_cloud.__version__
-# The full version, including alpha/beta/rc tags.
 release = watson_developer_cloud.__version__
 
 # 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.
-exclude_patterns = ['_build']
-
-# The reST default role (used for this markup: `text`) to use for all
-# documents.
-#default_role = None
+exclude_patterns = ['_build', '_templates',
+    'apis/modules.rst','apis/watson_developer_cloud.rst',
+    'apis/watson_developer_cloud.version.rst',
+    'apis/watson_developer_cloud.watson_developer_cloud_service.rst']
 
 # If true, '()' will be appended to :func: etc. cross-reference text.
-#add_function_parentheses = True
+add_function_parentheses = False
 
 # If true, the current module name will be prepended to all description
 # unit titles (such as .. function::).
-#add_module_names = True
+add_module_names = False
 
 # If true, sectionauthor and moduleauthor directives will be shown in the
 # output. They are ignored by default.
@@ -116,7 +74,7 @@
 pygments_style = 'sphinx'
 
 # A list of ignored prefixes for module index sorting.
-#modindex_common_prefix = []
+modindex_common_prefix = ['watson_developer_cloud.']
 
 # If true, keep warnings as "system message" paragraphs in the built documents.
 #keep_warnings = False
@@ -127,10 +85,20 @@
 
 # -- 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 = 'alabaster'
+
 # 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 = {}
+html_theme_options = {
+    'show_powered_by': False,
+    'github_user': 'watson-developer-cloud',
+    'github_repo': 'python-sdk',
+    'github_banner': False,
+    'show_related': False
+}
 
 # Add any paths that contain custom themes here, relative to this directory.
 #html_theme_path = []
@@ -146,10 +114,10 @@
 # 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
+# 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
+html_favicon = '_static/favicon.ico'
 
 # 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,
@@ -163,36 +131,38 @@
 
 # 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'
+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 = {}
+html_sidebars = {
+    '**': ['localtoc.html','sidebarintro.html', 'relations.html', 'sourcelink.html', 'searchbox.html']
+}
 
 # 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
+html_domain_indices = True
 
 # If false, no index is generated.
-#html_use_index = True
+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
+html_show_sourcelink = False
 
 # 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 = False
 
 # 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
@@ -239,8 +209,8 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-  (master_doc, 'WatsonDeveloperCloudPythonSDK.tex', u'Watson Developer Cloud Python SDK Documentation',
-   u'Jeff Stylos', 'manual'),
+    (master_doc, 'WatsonDeveloperCloudPythonSDK.tex', u'Watson Developer Cloud Python SDK Documentation',
+     u'IBM Corp.', 'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
@@ -283,9 +253,9 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-  (master_doc, 'WatsonDeveloperCloudPythonSDK', u'Watson Developer Cloud Python SDK Documentation',
-   author, 'WatsonDeveloperCloudPythonSDK', 'One line description of project.',
-   'Miscellaneous'),
+    (master_doc, 'WatsonDeveloperCloudPythonSDK', u'Watson Developer Cloud Python SDK Documentation',
+     author, 'WatsonDeveloperCloudPythonSDK', 'Python client library to quickly get started with the various Watson Developer Cloud services.',
+     'Miscellaneous'),
 ]
 
 # Documents to append as an appendix to all manuals.
@@ -299,3 +269,7 @@
 
 # If true, do not generate a @detailmenu in the "Top" node's menu.
 #texinfo_no_detailmenu = False
+
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {'https://docs.python.org/': None}

docs/conf.py

@@ -0,0 +1,40 @@
+#!/bin/sh
+
+# based on https://odoepner.wordpress.com/2012/02/17/shell-script-to-generate-simple-index-html/
+
+echo '<!DOCTYPE html>
+<html>
+<head>
+    <meta charset="utf-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <title>IBM Watson Developer Cloud</title>
+    <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css" integrity="sha384-1q8mTJOASx8j1Au+a5WDVnPi2lkFfwwEAa8hDDdjZlpLegxhjVME1fgjWPGmkzs7" crossorigin="anonymous">
+</head>
+<body>
+<div class="container">
+    <div class="page-header">
+        <h1>IBM Watson Developer Cloud Python SDK</h1>
+    </div>
+
+    <p><a href="http://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/">Info</a>
+        | <a href="http://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/doc/">Documentation</a>
+        | <a href="https://github.com/watson-developer-cloud/python-sdk">GitHub</a>
+        | <a href="https://pypi.python.org/pypi/watson-developer-cloud">pypi</a>
+    </p>
+
+    <p>Documentation by branch/tag:</p>
+    <ul>'
+ls | grep --invert-match index.html | sed 's/^.*/<li><a href="&">&<\/a><\/li>/'
+echo '    </ul>
+</div>
+<script>
+    (function(i,s,o,g,r,a,m){i["GoogleAnalyticsObject"]=r;i[r]=i[r]||function(){
+                (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+            m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+    })(window,document,"script","//www.google-analytics.com/analytics.js","ga");
+    ga("create", "UA-59827755-11", "auto");
+    ga("send", "pageview");
+</script>
+</body>
+</html>'