Cleaning API Docs Generation

.gitignore

@@ -64,3 +64,6 @@ target/
 # Mac OS X
 .DS_Store
 docs/html/
+
+# Generated Documentation
+docs/dev/generate/

docs/conf.py

@@ -15,6 +15,7 @@
 import os
 import sys
 import datacube
+import glob
 
 # 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
@@ -40,9 +41,11 @@
     'sphinx.ext.autodoc',
     'sphinx.ext.autosummary',
     'sphinx.ext.viewcode',
-    'sphinxcontrib.blockdiag'
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.extlinks'
 ]
 
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
@@ -106,9 +109,15 @@
 # If true, keep warnings as "system message" paragraphs in the built documents.
 #keep_warnings = False
 
-# Get rid of warnings about 'toctree contains reference to nonexisting document'
-# See https://github.com/phn/pytpm/issues/3#issuecomment-12133978 for more details
-numpydoc_show_class_members = False
+autosummary_generate = True
+
+extlinks = {'issue': ('https://github.com/data-cube/agdc-v2/issues/%s', 'GH')}
+intersphinx_mapping = {
+    'python': ('https://docs.python.org/2.7/', None),
+    'pandas': ('http://pandas.pydata.org/pandas-docs/stable/', None),
+    'iris': ('http://scitools.org.uk/iris/docs/latest/', None),
+    'numpy': ('http://docs.scipy.org/doc/numpy/', None),
+}
 
 
 # -- Options for HTML output ----------------------------------------------

docs/dev/api.rst

@@ -2,7 +2,7 @@ Data Access API
 ===============
 
 For examples on how to use the API, see the Jupyter notebooks at:
-https://github.com/data-cube/agdc-v2/tree/develop/examples/notebooks
+http://nbviewer.jupyter.org/github/data-cube/agdc-v2/blob/unification/examples/notebooks/The%20Unified%20Datacube%20Notebook.ipynb
 
 
 .. currentmodule:: datacube.api
@@ -11,36 +11,44 @@ Datacube Class
 --------------
 
 
-Create Accessor
-~~~~~~~~~~~~~~~
-
 .. autosummary::
 
    Datacube.__init__
 
 
-Search Available Data
-~~~~~~~~~~~~~~~~~~~~~
+Core Functions
+~~~~~~~~~~~~~~
 
 .. autosummary::
+   :toctree: generate/
 
    Datacube.products
-   Datacube.variables
-   Datacube.list_variables
+   Datacube.measurements
+   Datacube.load
+
+
+Advanced Functions
+~~~~~~~~~~~~~~~~~~
 
+.. autosummary::
+   :toctree: generate/
 
-   Datacube.get_dataset
-   Datacube.get_data_array
+   Datacube.product_data
    Datacube.product_observations
    Datacube.product_sources
-   Datacube.product_data
-   Datacube.variable_data
-   Datacube.variable_data_lazy
 
 
-Class Definition
-----------------
+   Datacube.measurement_data
+   Datacube.measurement_data_lazy
+
+   Datacube.list_measurements
+
+
+
+Analytics Engine API
+--------------------
 
 .. autoclass:: datacube.api.API
   :special-members: __init__
   :members:
+

docs/ops/windows.rst

@@ -32,7 +32,7 @@ Python 2.7 or Python 3.5 environment
 .. note::
 
     **3.5 only workaround**: Copy ``vcruntime140.dll`` from Python install dir into
-    virtualenv `Scripts\` folder.
+    virtualenv ``Scripts\`` folder.
 
 5. Activate virtualenv::