Updated API docs to comment out the analysis routines - these need to…

… be rationalised before they are formally documented. See JASCIS-258.
cedadev · Sep 3, 2015 · 6191d2f · 6191d2f
1 parent 66e00e2
commit 6191d2f
Showing 1 changed file with 17 additions and 16 deletions.
diff --git a/doc/api.rst b/doc/api.rst
@@ -4,29 +4,30 @@ CIS as a Python library (API)
 
 Reading and Writing
 ===================
-    from cis import read_data, read_data_list
+    ``from cis import read_data, read_data_list``
 
 
 Data Objects
 ============
 
 
-Collocation
-===========
-    from cis.collocation import Collocate
+.. These API are to be finalised before they are officially documented (to save needing a major version change)
+    Collocation
+    ===========
+        from cis.collocation import Collocate
 
-Aggregation
-===========
-    from cis.aggregation import Aggregate
+..    Aggregation
+    ===========
+        from cis.aggregation import Aggregate
 
-Subsetting
-==========
-    from cis.subsetting import Subset
+..    Subsetting
+    ==========
+        from cis.subsetting import Subset
 
-Plotting
-========
-    from cis.plotting import Plotter
+..    Plotting
+    ========
+        from cis.plotting import Plotter
 
-Stats
-=====
-    from cis.stats import StatsAnalyzer
+..    Stats
+    =====
+        from cis.stats import StatsAnalyzer