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-12-10 22:44:39 -05:00
parent 8a575f183e
commit 22f8ee62e3
4 changed files with 17 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
Makefile
View File

@ -18,4 +18,4 @@ UNINSTALL_DIRS += $(wildcard $(INSTALL_LOCATION)/python*)
#useful targets includ: doc-html and doc-clean #useful targets includ: doc-html and doc-clean
doc-%: doc-%:
PYTHONPATH=$$PWD/python $(MAKE) -C documentation $* PYTHONPATH=$$PWD/python$(PY_VER)/$(EPICS_HOST_ARCH) $(MAKE) -C documentation $*

2
documentation/devsup.rst
View File

@ -3,8 +3,6 @@ devsup Package
.. module:: devsup .. module:: devsup
.. autofunction:: devsup.verinfo
.. data:: NO_ALARM, MINOR_ALARM, MAJOR_ALARM, INVALID_ALARM .. data:: NO_ALARM, MINOR_ALARM, MAJOR_ALARM, INVALID_ALARM
Constants for alarm severity. Use with :meth:`Record.setSevr <.db.Record.setSevr>` Constants for alarm severity. Use with :meth:`Record.setSevr <.db.Record.setSevr>`

19
documentation/environment.rst
View File

@ -4,7 +4,7 @@ Runtime Environment
The pyDevSup module initializes the interpreter during the registration The pyDevSup module initializes the interpreter during the registration
phase of IOC startup with the *pySetupReg* registrar function. :: phase of IOC startup with the *pySetupReg* registrar function. ::
#!../../bin/linux-x86_64/softIocPy #!../../bin/linux-x86_64/softIocPy2.7
# Interpreter not started # Interpreter not started
dbLoadDatabase("../../dbd/softIocPy.dbd",0,0) dbLoadDatabase("../../dbd/softIocPy.dbd",0,0)
softIocPy_registerRecordDeviceDriver(pdbbase) softIocPy_registerRecordDeviceDriver(pdbbase)
@ -48,7 +48,11 @@ file. ::
PYDEVSUP=/dir/where/pyDevSup/is/installed PYDEVSUP=/dir/where/pyDevSup/is/installed
EPICS_BASE=/.... EPICS_BASE=/....
The following should be added to the usual EPICS Makefiles. :: The default or preferred Python version can be specificed in *configure/CONFIG_SITE* ::
PY_VER ?= 2.7
The following should be added to individual EPICS Makefiles. ::
TOP=../.. TOP=../..
include $(TOP)/configure/CONFIG include $(TOP)/configure/CONFIG
@ -66,7 +70,7 @@ which may be the same as ``PY_VER``.
Include pyDevSup in your IOC Include pyDevSup in your IOC
---------------------------- ----------------------------
While the *softIocPy* executable built as part of this module While the *softIocPyX.Y* executable(s) built as part of this module
will be sufficient for many uses, it is also possible to will be sufficient for many uses, it is also possible to
include the pyDevSup modules in an IOC along with other drivers. include the pyDevSup modules in an IOC along with other drivers.
This can be done in the usual way. :: This can be done in the usual way. ::
@ -108,11 +112,12 @@ Installing for several Python versions
The recipe for building and installing the pyDevSup module The recipe for building and installing the pyDevSup module
for several python version side by side is :: for several python version side by side is ::
make PYTHON=python2.6 make PY_VER=2.6
make clean make clean
make PYTHON=python2.7 make PY_VER=2.7
make clean make clean
make PYTHON=python3 make PY_VER=3.2
make clean make clean
Note that the ``softIocPy`` will by build for the last version only. The ``PYTHON`` make variable can be specified if the interpreter executable
has a name other than ``python$(PY_VER)``.

4
documentation/index.rst
View File

@ -6,6 +6,10 @@
pydevsup documentation pydevsup documentation
====================== ======================
*pyDevSup* is a means of writing EPICS device support code in Python.
It currently supports EPICS >=3.14.11 and python versions: 2.6, 2.7, and 3.2.
Contents: Contents:
.. toctree:: .. toctree::