Merge branch 'product_handbook_2.0'

doc/api_reference.rst

@@ -2,5 +2,6 @@
 CAB-LAB API Reference
 =====================
 
-.. automodule:: cablab
-   :members:
+.. index:: API
+
+Cab-Lab API Reference is available `here <_static/api_reference.html>`_.

doc/conf.py

@@ -56,16 +56,19 @@
 # General information about the project.
 project = 'CAB-LAB'
 copyright = '2016, Brockmann Consult GmbH'
-author = 'Brockmann Consult GmbH'
+author1 = 'Brockmann Consult GmbH'
+author2 = 'MPI for Biogeochemistry Jena'
+author3 = 'Stockholm Resilience Centre'
+cablab_logo = "pix/CablabLogo2.png"
 
 # 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'
+version = '2.0'
 # The full version, including alpha/beta/rc tags.
-release = '0.1'
+release = '2.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -135,7 +138,7 @@
 
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
-#html_logo = None
+html_logo = cablab_logo
 
 # 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
@@ -231,16 +234,16 @@
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
   (master_doc, 'CAB-LAB.tex', 'CAB-LAB Documentation',
-   'Brockmann Consult GmbH', 'manual'),
+   r'Brockmann Consult GmbH \and MPI Biogeochemistry Jena \and Stockholm Resilience Centre', 'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
 # the title page.
-#latex_logo = None
+latex_logo = cablab_logo
 
 # For "manual" documents, if this is true, then toplevel headings are parts,
 # not chapters.
-#latex_use_parts = False
+latex_use_parts = True
 
 # If true, show page references after internal links.
 #latex_show_pagerefs = False
@@ -252,7 +255,7 @@
 #latex_appendices = []
 
 # If false, no module index is generated.
-#latex_domain_indices = True
+latex_domain_indices = False
 
 
 # -- Options for manual page output ---------------------------------------
@@ -261,7 +264,7 @@
 # (source start file, name, description, authors, manual section).
 man_pages = [
     (master_doc, 'cab-lab', 'CAB-LAB Documentation',
-     [author], 1)
+     [author1, author2, author3], 1)
 ]
 
 # If true, show URL addresses after external links.
@@ -275,7 +278,7 @@
 #  dir menu entry, description, category)
 texinfo_documents = [
   (master_doc, 'CAB-LAB', 'CAB-LAB Documentation',
-   author, 'CAB-LAB', 'One line description of project.',
+   [author1, author2, author3], 'CAB-LAB', 'One line description of project.',
    'Miscellaneous'),
 ]
 
@@ -296,8 +299,8 @@
 
 # Bibliographic Dublin Core info.
 epub_title = project
-epub_author = author
-epub_publisher = author
+epub_author = author1
+epub_publisher = author1
 epub_copyright = copyright
 
 # The basename for the epub file. It defaults to the project name.

doc/cube_explanation.rst

@@ -1,3 +1,5 @@
+.. index:: Earth System Data Cube
+
 ===================================
 What is the Earth System Data Cube?
 ===================================
@@ -21,6 +23,8 @@ the ESDC. While all observational values are conserved, gaps are filled with syn
 adequate gap-filling algorithm. Proper data flags ensure an unambiguous distinction between observational and
 synthetic data values.
 
+.. index:: ESDC Macro Structure
+
 ESDC Macro Structure
 =========================
 
@@ -31,6 +35,8 @@ of the subsystems of interest:
 * Atmospheric forcing
 * Socio-economic data
 
+.. index:: Cube Spatial and Temporal Coverage
+
 Spatial and Temporal Coverage
 =============================
 

doc/index.rst

@@ -6,6 +6,7 @@ Contents:
 
 .. toctree::
    :maxdepth: 3
+   :numbered:
 
    intro
    cube_explanation
@@ -21,7 +22,6 @@ Indices and Tables
 ==================
 
 * :ref:`genindex`
-* :ref:`modindex`
 * :ref:`search`
 
 

doc/intro.rst

@@ -85,6 +85,8 @@ Grid                     The Data Cube's layout given by its spatial and tempora
 Image                    An 2D data cube subset with dimension (lat, lon)
 =======================  =============================================================================================
 
+.. index:: Legal information
+
 Legal information
 =================
 
@@ -107,6 +109,8 @@ along with this program. If not, see http://www.gnu.org/licenses/.
 
 Copyright (C) 2016  The CAB-LAB developer team.
 
+.. index:: Data Policy
+
 Data Policy
 ===========
 
@@ -123,4 +127,4 @@ the respective data owners.
 
     Please cite the Earth System Data Cube as:
 
-    The CAB-LAB developer team (2016). The Earth System Data Cube (Version 0.1), available at: https://github.com/CAB-LAB.
+    The CAB-LAB developer team (2016). The Earth System Data Cube (Version 0.1), available at: https://github.com/CAB-LAB.