Merge pull request #36 from andersy005/master

Update Documentation for next release

Author: andersy005

CHANGELOG.rst

@@ -1 +1,29 @@
+=================
+Changelog history
+=================
 
+
+Intake-esm v2019.2.28 (2019-02-28)
+===================================
+
+
+Features
+---------
+
+- Allow CMIP integration (:pr:`35`) `Anderson Banihirwe`_
+
+Bug Fixes
+----------
+
+- Fix bug on build catalog and move `exclude_dirs` to `locations` (:pr:`33`) `Matthew Long`_
+
+
+Trivial/Internal Changes
+------------------------
+
+- Change Logger, update dev-environment dependencies, and formatting fix in input.yml (:pr:`31`) `Matthew Long`_
+- Update CircleCI workflow (:pr:`32`) `Anderson Banihirwe`_
+- Rename package from `intake-cesm` to `intake-esm` (:pr:`34`) `Anderson Banihirwe`_
+
+.. _`Anderson Banihirwe`: https://github.com/andersy005
+.. _`Matthew Long`: https://github.com/matt-long

MANIFEST.in

@@ -4,9 +4,10 @@ include LICENSE
 include README.rst
 include requirements.txt
 
+recursive-include tests
 recursive-include example_input
 recursive-include intake_esm *.py
 recursive-exclude * __pycache__
 recursive-exclude * *.py[co]
 include versioneer.py
-include intake_esm/_version.py
+include intake_esm/_version.py

docs/source/conf.py

@@ -33,34 +33,38 @@
 # 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.viewcode",
-    "sphinx.ext.autosummary",
-    "sphinx.ext.doctest",
-    "sphinx.ext.intersphinx",
-    "sphinx.ext.extlinks",
-    "numpydoc",
-    "IPython.sphinxext.ipython_console_highlighting",
-    "IPython.sphinxext.ipython_directive",
-    "nbsphinx",
+    'sphinx.ext.autodoc',
+    'sphinx.ext.viewcode',
+    'sphinx.ext.autosummary',
+    'sphinx.ext.doctest',
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.extlinks',
+    'numpydoc',
+    'IPython.sphinxext.ipython_console_highlighting',
+    'IPython.sphinxext.ipython_directive',
+    'nbsphinx',
 ]
 
+extlinks = {
+    'issue': ('https://github.com/NCAR/intake-esm/issues/%s', 'GH#'),
+    'pr': ('https://github.com/NCAR/intake-esm/pull/%s', 'GH#'),
+}
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ["_templates"]
+templates_path = ['_templates']
 
 # The suffix of source filenames.
-source_suffix = ".rst"
+source_suffix = '.rst'
 
 # The encoding of source files.
 # source_encoding = 'utf-8-sig'
 
 # The master toctree document.
-master_doc = "index"
+master_doc = 'index'
 
 # General information about the project.
-project = u"intake-esm"
-copyright = u"2019 onwards, NCAR"
-authors = ["Anderson Banihirwe", "Matthew Long"]
+project = u'intake-esm'
+copyright = u'2019 onwards, NCAR'
+author = u'Earth System Informatics Team'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -83,7 +87,7 @@
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = ["_build"]
+exclude_patterns = ['_build']
 
 # The reST default role (used for this markup: `text`) to use for all documents.
 # default_role = None
@@ -100,7 +104,7 @@
 # show_authors = False
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = "sphinx"
+pygments_style = 'sphinx'
 
 # A list of ignored prefixes for module index sorting.
 # modindex_common_prefix = []
@@ -113,7 +117,7 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = "sphinx_rtd_theme"
+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
@@ -142,7 +146,7 @@
 # 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"]
+html_static_path = ['_static']
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
@@ -186,7 +190,7 @@
 # html_file_suffix = None
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = "intake_esmdoc"
+htmlhelp_basename = 'intake_esmdoc'
 
 
 # -- Options for LaTeX output --------------------------------------------------
@@ -202,7 +206,7 @@
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, documentclass [howto/manual]).
-latex_documents = [("index", "intake-esm.tex", u"intake-esm Documentation", authors, "manual")]
+latex_documents = [('index', 'intake-esm.tex', u'intake-esm Documentation', author, 'manual')]
 
 # The name of an image file (relative to this directory) to place at the top of
 # the title page.
@@ -229,7 +233,7 @@
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [("index", "intake-esm", u"intake-esm Documentation", authors, 1)]
+man_pages = [('index', 'intake-esm', u'intake-esm Documentation', [author], 1)]
 
 # If true, show URL addresses after external links.
 # man_show_urls = False
@@ -242,13 +246,13 @@
 #  dir menu entry, description, category)
 texinfo_documents = [
     (
-        "index",
-        "intake-esm",
-        u"intake-esm Documentation",
-        authors,
-        "intake-esm",
-        "One line description of project.",
-        "Miscellaneous",
+        'index',
+        'intake-esm',
+        u'intake-esm Documentation',
+        author,
+        'intake-esm',
+        'One line description of project.',
+        'Miscellaneous',
     )
 ]