/iocdoc

Document the configuration of an EPICS IOC

Primary LanguageBatchfile

IOCDOC: Document the configuration of an EPICS IOC

iocdoc: Document the configuration of an EPICS IOC

version
release
published
docs

http://iocdoc.readthedocs.org

git

https://github.com/prjemian/iocdoc.git

PyPI

https://pypi.python.org/pypi/iocdoc

TODO list

https://github.com/prjemian/iocdoc/issues

author

Pete R. Jemian

email

jemian@anl.gov

copyright

2016, UChicago Argonne, LLC

license

ANL OPEN SOURCE LICENSE (see LICENSE)

The user will provide the directory path (absolute or relative) to an EPICS IOC startup command file. The IOC startup file will specify the starting point to discover the configuration of each IOC.

This code will parse the startup command file and discover the commands and databases used to start the IOC. An attempt is made to read the database files. This program will report if a file or database is not found.

The goal is to generate a set of WWW pages with appropriate links to standard documentation for all the commands and other common support. Links will be made to any local documentation provided in the ./documentation directory of the top level directory.