[NeXus-definitions-tickets] [NeXusDefinitions] #191: Create package and release tools for NeXus documentation

[NeXus Base Classes and Instrument Definitions]

#191: Create package and release tools for NeXus documentation
-------------------------+------------------------------
 Reporter:  Pete Jemian  |      Owner:  Unassigned
     Type:  task         |     Status:  new
 Priority:  major        |  Milestone:  release NXDL 1.0
Component:  general      |   Keywords:
-------------------------+------------------------------
 The NeXus documentation needs to be packaged for each release. We need
 some tools (shell scripts) to automate this.  We should release the manual
 as ''NeXus documentation'' that includes documentation for code, NXDL, and
 supplied applications.

 Separate releases for each part of the documentation:
 * manual (from DocBook)
 * code documentation (from doxygen)
 * application documentation (from doxygen)

 What formats to package?
 * PDF
 * HTML
 * '''epub''' ???


 The package containers should be:
 * .rpm yum packages (RedHat/Fedora Linux)
 * .deb apt packages (Debian/Ubuntu Linux)
 * .tar.gz tarball packages (generic *nix)
 * .zip Zip packages (Windows)


 The code branch is more complex:
 * need to examine
 * most is in doxygen
 * Could unify all or separate by bindings into separate release
   * unified is faster - can deploy faster now
   * separate is more natural
 * need to link from manual to the doxygen parts
   * needs table of contents type of page

 Freddie will make a unified release file.  We'll see if more subdivision
 is necessary.

-- 
Ticket URL: <http://trac.nexusformat.org/definitions/ticket/191>
NeXus Base Classes and Instrument Definitions <http://www.nexusformat.org/>
NeXus Base Classes and Instrument Definitions