Changeset 624

Timestamp:

Aug 21, 2011 3:15:37 PM (12 years ago)

Author:

jemian

Message:

converted documentation into initial sphinx documentation -- most code modules need better docstrings

Location:

pvrrd

Files:

• doc/build (modified) (1 prop)
• doc/source/index.rst (modified) (1 diff)
• doc/source/overview.rst (added)
• doc/source/src/cgiCreate.rst (added)
• doc/source/src/epics2rrd.rst (modified) (1 diff, 1 prop)
• doc/source/src/htmlCreate.rst (added)
• doc/source/src/makeTagHTML.rst (added)
• doc/source/src/pvwatch.rst (added)
• doc/source/src/rrdCreate.rst (added)
• doc/source/src/rrd_pv.rst (added)
• doc/source/src/xmlSupport.rst (added)
• doc/source/status.rst (added)
• doc/source/toc.rst (modified) (2 diffs)
• doc/source/usage.rst (added)
• src/pvrrd/documentation.html (modified) (1 diff)

pvrrd/doc/source/index.rst

@@ -4 +4 @@
 =================================
 
-TODO: words of introduction
+Logs EPICS numerical PVs into RRD files and maintains 
+a set of plots for WWW browsing.
+
+This tool records the value of an EPICS (numerical) 
+process variable and peridically records the value into 
+an `rrd <http://oss.oetiker.ch/rrdtool/>`_ database. 
+The database has been configured to present plots for the:
+
+* last hour
+* last day
+* last week
+* last month
+* last year
+* last decade. 
+
+A Python script monitors the PVs and updates the databases. 
+Each PV has its own database which simplifies the addition 
+or removal of PVs from interest. 
+
+A PHP page has been built to provide access to the 
+suite of databases from WWW clients. 
+The ``index.php`` page builds a list of available data 
+and presents that to the WWW client as a table and a 
+representative plot. A link from each PV will bring 
+up a page with plots of the six time spans described 
+for that PV. These pages are generated by CGI scripts, 
+with information pulled immediately from what is 
+available in the database. 
 
 Contents:

pvrrd/doc/source/src/epics2rrd.rst

@@ -1 @@
-.. $Id: Element.rst 93 2011-08-20 17:30:31Z jemian $
+.. $Id$
 
 --------------------------

pvrrd/doc/source/toc.rst

@@ -1 +1 @@
 .. $Id$
+
+Basic Usage
+====================================
+
+.. toctree::
+   :maxdepth: 2
+   :glob:
+   
+   usage
+   overview
+   status
 
 More information
@@ -6 +17 @@
 For more information:
 
-* see: https://subversion.xor.aps.anl.gov/trac/bcdaext/pvrrd
+* see: https://subversion.xor.aps.anl.gov/trac/bcdaext/browser/pvrrd
 * `documentation  <https://subversion.xor.aps.anl.gov/bcdaext/pvrrd/doc/build/html/index.html>`_
 * download source: ``svn co https://subversion.xor.aps.anl.gov/bcdaext/pvrrd/ pvrrd``

pvrrd/src/pvrrd/documentation.html

@@ -227 +227 @@
 the www page content (text and plots) on demand.  It may be necessary to force the
 page to refresh the local browser cache in order for some of the
-olnger-term plots to be rebuilt.  Usually, <shift>-"Refresh" or similar will get this done.
+longer-term plots to be rebuilt.  Usually, <shift>-"Refresh" or similar will get this done.
 </p>