lin-epics-modules/pyDevSup
0
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

more doc

Browse Source
This commit is contained in:
Michael Davidsaver
2013-04-14 16:24:37 -04:00
parent 229eb81864
commit ffc6ec396f
5 changed files with 34 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
documentation/conf.py
View File

@ -40,17 +40,17 @@ source_suffix = '.rst'
master_doc = 'index' master_doc = 'index'
# General information about the project. # General information about the project.
project = u'devsup' project = u'pyDevSup'
copyright = u'2013, Author' copyright = u'2013, Michael Davidsaver'
# The version info for the project you're documenting, acts as replacement for # The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the # |version| and |release|, also used in various other places throughout the
# built documents. # built documents.
# #
# The short X.Y version. # The short X.Y version.
version = '' version = '0.1'
# The full version, including alpha/beta/rc tags. # The full version, including alpha/beta/rc tags.
release = '' release = '0.1-dev'
# The language for content autogenerated by Sphinx. Refer to documentation # The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages. # for a list of supported languages.
@ -183,8 +183,8 @@ latex_elements = {
# Grouping the document tree into LaTeX files. List of tuples # Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]). # (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [ latex_documents = [
('index', 'devsup.tex', u'devsup Documentation', ('index', 'devsup.tex', u'pyDevSup Documentation',
u'Author', 'manual'), u'Michael Davidsaver', 'manual'),
] ]
# The name of an image file (relative to this directory) to place at the top of # The name of an image file (relative to this directory) to place at the top of
@ -213,8 +213,8 @@ latex_documents = [
# One entry per manual page. List of tuples # One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section). # (source start file, name, description, authors, manual section).
man_pages = [ man_pages = [
('index', 'devsup', u'devsup Documentation', ('index', 'devsup', u'pyDevSup Documentation',
[u'Author'], 1) [u'Michael Davidsaver'], 1)
] ]
# If true, show URL addresses after external links. # If true, show URL addresses after external links.
@ -227,8 +227,8 @@ man_pages = [
# (source start file, target name, title, author, # (source start file, target name, title, author,
# dir menu entry, description, category) # dir menu entry, description, category)
texinfo_documents = [ texinfo_documents = [
('index', 'devsup', u'devsup Documentation', ('index', 'devsup', u'pyDevSup Documentation',
u'Author', 'devsup', 'One line description of project.', u'Michael Davidsaver', 'devsup', 'One line description of project.',
'Miscellaneous'), 'Miscellaneous'),
] ]
@ -245,10 +245,10 @@ texinfo_documents = [
# -- Options for Epub output --------------------------------------------------- # -- Options for Epub output ---------------------------------------------------
# Bibliographic Dublin Core info. # Bibliographic Dublin Core info.
epub_title = u'devsup' epub_title = u'pyDevSup'
epub_author = u'Author' epub_author = u'Michael Davidsaver'
epub_publisher = u'Author' epub_publisher = u'Michael Davidsaver'
epub_copyright = u'2013, Author' epub_copyright = u'2013, Michael Davidsaver'
# The language of the text. It defaults to the language option # The language of the text. It defaults to the language option
# or en if the language is not set. # or en if the language is not set.

12
documentation/devsup.rst
View File

@ -1,8 +1,18 @@
devsup Package devsup Package
============== ==============
.. module:: devsup
.. autofunction:: devsup.verinfo .. autofunction:: devsup.verinfo
.. data:: NO_ALARM, MINOR_ALARM, MAJOR_ALARM, INVALID_ALARM
Constants for alarm severity. Use with :meth:`Record.setSevr <.db.Record.setSevr>`
.. data:: NO_ALARM, READ_ALARM, WRITE_ALARM, ...
Constants for alarm status. Use with :meth:`Record.setSevr <.db.Record.setSevr>`
:mod:`db` Module :mod:`db` Module
---------------- ----------------
@ -40,6 +50,8 @@ devsup Package
.. automethod:: field .. automethod:: field
.. automethod:: setSevr
.. automethod:: setTime .. automethod:: setTime
.. automethod:: scan .. automethod:: scan

4
documentation/index.rst
View File

@ -3,8 +3,8 @@
You can adapt this file completely to your liking, but it should at least You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive. contain the root `toctree` directive.
Welcome to devsup's documentation! pydevsup documentation
================================== ======================
Contents: Contents:

7
python/devsup/_nullapi.py
View File

@ -49,9 +49,12 @@ class _Record(object):
""" """
def setSevr(self, sevr=3, stat=15): def setSevr(self, sevr=3, stat=15):
"""setSevr(sevr=INVALID, stat=COMM) """setSevr(sevr=INVALID_ALARM, stat=COMM_ALARM)
Set new alarm condition. Signal a new alarm condition. The effect of this
call depends on the current alarm condition.
See :c:func:`recGblSetSevr` in EPICS Base.
""" """
def scan(self, sync=False, reason=None, force=0): def scan(self, sync=False, reason=None, force=0):

2
python/devsup/db.py
View File

@ -241,7 +241,7 @@ class Record(_dbapi._Record):
def setTime(self, ts): def setTime(self, ts):
"""Set record timestamp. """Set record timestamp.
:param ts: timetuple, float, or (sec, nsec). :param ts: datetime, float, or (sec, nsec).
Has not effect if the TSE field is not set to -2. Has not effect if the TSE field is not set to -2.
All inputs must be referenced to the posix epoch. All inputs must be referenced to the posix epoch.