climate-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jo...@apache.org
Subject svn commit: r1535868 - in /incubator/climate/trunk/docs/source: conf.py data_source/ data_source/data_sources.rst index.rst
Date Fri, 25 Oct 2013 20:46:39 GMT
Author: joyce
Date: Fri Oct 25 20:46:38 2013
New Revision: 1535868

URL: http://svn.apache.org/r1535868
Log:
CLIMATE-319 - Add data sources to sphinx build

- Add data_sources.rst which contains automodule directive generated
  documentation for the local, RCMED, and DAP data source modules.
- Add the data source documentation to the index.
- Update the path to include a relative path to the data_source
  directory in the OCW package.

Added:
    incubator/climate/trunk/docs/source/data_source/
    incubator/climate/trunk/docs/source/data_source/data_sources.rst
Modified:
    incubator/climate/trunk/docs/source/conf.py
    incubator/climate/trunk/docs/source/index.rst

Modified: incubator/climate/trunk/docs/source/conf.py
URL: http://svn.apache.org/viewvc/incubator/climate/trunk/docs/source/conf.py?rev=1535868&r1=1535867&r2=1535868&view=diff
==============================================================================
--- incubator/climate/trunk/docs/source/conf.py (original)
+++ incubator/climate/trunk/docs/source/conf.py Fri Oct 25 20:46:38 2013
@@ -20,6 +20,7 @@ import sys, os
 #
 # Assuming a fresh checkout of trunk, this will point us to the OCW package
 sys.path.insert(0, os.path.abspath('../../ocw'))
+sys.path.insert(0, os.path.abspath('../../ocw/data_source'))
 
 
 # -- General configuration -----------------------------------------------------

Added: incubator/climate/trunk/docs/source/data_source/data_sources.rst
URL: http://svn.apache.org/viewvc/incubator/climate/trunk/docs/source/data_source/data_sources.rst?rev=1535868&view=auto
==============================================================================
--- incubator/climate/trunk/docs/source/data_source/data_sources.rst (added)
+++ incubator/climate/trunk/docs/source/data_source/data_sources.rst Fri Oct 25 20:46:38 2013
@@ -0,0 +1,17 @@
+Data Sources
+************
+
+Local Module
+============
+.. automodule:: local
+    :members:
+
+RCMED Module
+============
+.. automodule:: rcmed
+    :members:
+
+DAP Module
+==========
+.. automodule:: dap
+    :members:

Modified: incubator/climate/trunk/docs/source/index.rst
URL: http://svn.apache.org/viewvc/incubator/climate/trunk/docs/source/index.rst?rev=1535868&r1=1535867&r2=1535868&view=diff
==============================================================================
--- incubator/climate/trunk/docs/source/index.rst (original)
+++ incubator/climate/trunk/docs/source/index.rst Fri Oct 25 20:46:38 2013
@@ -16,6 +16,7 @@ Contents:
    ocw/evaluation
    ocw/metrics
    ocw/plotter
+   data_source/data_sources
 
 
 Indices and tables



Mime
View raw message