climate-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jo...@apache.org
Subject svn commit: r1535861 - in /incubator/climate/trunk/docs/source: index.rst ocw/ ocw/dataset.rst
Date Fri, 25 Oct 2013 20:46:11 GMT
Author: joyce
Date: Fri Oct 25 20:46:11 2013
New Revision: 1535861

URL: http://svn.apache.org/r1535861
Log:
CLIMATE-312 - Add dataset.py docs skeleton to Sphinx build

- Add dataset.rst which builds the dataset module's documentation with
  autodoc. This is only an initial skeleton. Still need to come through
  later and add more to this page.
- Add dataset documentation to the index.
- Up the maxdepth on the TOC for mild future-proofing.

Added:
    incubator/climate/trunk/docs/source/ocw/
    incubator/climate/trunk/docs/source/ocw/dataset.rst
Modified:
    incubator/climate/trunk/docs/source/index.rst

Modified: incubator/climate/trunk/docs/source/index.rst
URL: http://svn.apache.org/viewvc/incubator/climate/trunk/docs/source/index.rst?rev=1535861&r1=1535860&r2=1535861&view=diff
==============================================================================
--- incubator/climate/trunk/docs/source/index.rst (original)
+++ incubator/climate/trunk/docs/source/index.rst Fri Oct 25 20:46:11 2013
@@ -9,8 +9,9 @@ Welcome to Apache Open Climate Workbench
 Contents:
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 4
 
+   ocw/dataset
 
 
 Indices and tables

Added: incubator/climate/trunk/docs/source/ocw/dataset.rst
URL: http://svn.apache.org/viewvc/incubator/climate/trunk/docs/source/ocw/dataset.rst?rev=1535861&view=auto
==============================================================================
--- incubator/climate/trunk/docs/source/ocw/dataset.rst (added)
+++ incubator/climate/trunk/docs/source/ocw/dataset.rst Fri Oct 25 20:46:11 2013
@@ -0,0 +1,12 @@
+Dataset.py
+**********
+
+Bounds
+======
+.. autoclass:: dataset.Bounds
+    :members:
+
+Dataset
+=======
+.. autoclass:: dataset.Dataset
+    :members:



Mime
View raw message