admin.rst

Administrative Matters

Author

Author:	Pete R. Jemian [email protected]

.. index:: documentation; pdf, documentation; html

Documentation

html:	http://hdf5gateway.readthedocs.org
pdf:	http://hdf5gateway.readthedocs.org/en/latest/_downloads/HDF5gateway.pdf

.. index:: GitHub; subversion; source code

Downloads

.. index:: IgorExchange

IgorExchange

http://www.igorexchange.com/project/HDF5gateway

Just the most recent IgorPro procedure file (text) from the development trunk:

https://github.com/prjemian/hdf5gateway/blob/master/HDF5gateway.ipf

source code repository

https://github.com/prjemian/hdf5gateway

subversion repository retired 2015-05-14

https://subversion.xray.aps.anl.gov/small_angle/hdf5gateway

.. index:: documentation; building

Building the documentation

The documentation for HDF5gateway is built from .rst files and from content in the hdf5gateway.ipf IgorPro procedure file by a Python script called extractor.py, located in the same directory.

The current documentation was built: |today|.

Required:

• Python
• Sphinx
• LaTeX

How to build the documentation

1. change to the directory with the file extractor.py

2. extract the docs from the .ipf file and build the HTML docs:

   python extractor.py
   

3. build the LaTeX and then PDF files:

   make latexpdf
   

4. copy the PDF file to the source directory and rebuild the HTML:

   cp _build/latex/HDF5gateway.pdf ./
   python extractor.py
   

License

Copyright (c) 2012 University of Chicago. All rights reserved. See the :download:`LICENSE` file for details.