Changeset 627

Timestamp:

Aug 25, 2011 10:01:07 PM (12 years ago)

Author:

jemian

Message:

documentation

Location:

pvrrd/doc

Files:

• build/html (added)
• build/html/.buildinfo (added)
• build/html/_modules (added)
• build/html/_modules/index.html (added)
• build/html/_modules/pvrrd (added)
• build/html/_modules/pvrrd/makeTagHTML.html (added)
• build/html/_modules/pvrrd/pvwatch.html (added)
• build/html/_sources (added)
• build/html/_sources/index.txt (added)
• build/html/_sources/overview.txt (added)
• build/html/_sources/src (added)
• build/html/_sources/src/cgiCreate.txt (added)
• build/html/_sources/src/epics2rrd.txt (added)
• build/html/_sources/src/htmlCreate.txt (added)
• build/html/_sources/src/makeTagHTML.txt (added)
• build/html/_sources/src/pvwatch.txt (added)
• build/html/_sources/src/rrdCreate.txt (added)
• build/html/_sources/src/rrd_pv.txt (added)
• build/html/_sources/src/xmlSupport.txt (added)
• build/html/_sources/status.txt (added)
• build/html/_sources/toc.txt (added)
• build/html/_sources/usage.txt (added)
• build/html/_static (added)
• build/html/_static/basic.css (added)
• build/html/_static/contents.png (added)
• build/html/_static/doctools.js (added)
• build/html/_static/file.png (added)
• build/html/_static/jquery.js (added)
• build/html/_static/minus.png (added)
• build/html/_static/navigation.png (added)
• build/html/_static/plus.png (added)
• build/html/_static/pygments.css (added)
• build/html/_static/searchtools.js (added)
• build/html/_static/sphinxdoc.css (added)
• build/html/_static/underscore.js (added)
• build/html/genindex.html (added)
• build/html/index.html (added)
• build/html/objects.inv (added)
• build/html/overview.html (added)
• build/html/py-modindex.html (added)
• build/html/search.html (added)
• build/html/searchindex.js (added)
• build/html/src (added)
• build/html/src/cgiCreate.html (added)
• build/html/src/epics2rrd.html (added)
• build/html/src/htmlCreate.html (added)
• build/html/src/makeTagHTML.html (added)
• build/html/src/pvwatch.html (added)
• build/html/src/rrdCreate.html (added)
• build/html/src/rrd_pv.html (added)
• build/html/src/xmlSupport.html (added)
• build/html/status.html (added)
• build/html/toc.html (added)
• build/html/usage.html (added)
• source/index.rst (modified) (1 diff)
• source/toc.rst (modified) (1 diff)

pvrrd/doc/source/index.rst

@@ -7 +7 @@
 a set of plots for WWW browsing.
 
+:note:  See the Disclaimers on the *Contents* page for
+        some important messages.
+
 This tool records the value of an EPICS (numerical) 
-process variable and peridically records the value into 
+process variable and periodically records the value into 
 an `rrd <http://oss.oetiker.ch/rrdtool/>`_ database. 
 The database has been configured to present plots for the:

pvrrd/doc/source/toc.rst

@@ -21 +21 @@
 * download source: ``svn co https://subversion.xor.aps.anl.gov/bcdaext/pvrrd/ pvrrd``
 * contact: Pete Jemian (Advanced Photon Source) <jemian@anl.gov>
+* example: http://sector33.xor.aps.anl.gov/rrd/
+
+Disclaimers
+====================================
+
+:caution: The Sphinx documentation is new in 2011-08 and 
+          not complete.  It is missing, for example. the
+          ``rrdtool` parts.
+
+:note:  The project exists in its current state, as 
+        deployed at APS sectors 33 and 34.  It is not 
+        general due to certain configuration files.
+        An installation manual has not yet been written.
 
 Source Code Documentation