#@HEADER
# ************************************************************************
#
#            NOX: An Object-Oriented Nonlinear Solver Package
#                 Copyright (2002) Sandia Corporation
#
# Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
# license for use of this work by or on behalf of the U.S. Government.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
# 1. Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
#
# 2. Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution.
#
# 3. Neither the name of the Corporation nor the names of the
# contributors may be used to endorse or promote products derived from
# this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
# EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#
# Questions? Contact Roger Pawlowski (rppawlo@sandia.gov) or
# Eric Phipps (etphipp@sandia.gov), Sandia National Laboratories.
# ************************************************************************
#@HEADER


NOX Documentation
-----------------

You may access/create the NOX documentation in three ways...

1. ONLINE DOCUMENTATION

   The documentation is online at http://trilinos.sandia.gov/packages/nox.

2. MANUALLY GENERATE THE DOCUMENTATION

   Within the doc subdirectory, type

   > doxygen Doxyfile.default

   Then browse to doc/html/index.html to get started.

   Note that graphical dependency trees will not be generated with this option,
   since doxygen requires the "dot" library out of the graphviz
   package to build the graphics.  By using option 3 below, the
   configure script will check for the dot library and build the extra
   documentation.

3. AUTOMATICALLY GENERATE THE DOCUMENTATION

   Let $NOX_SRC denote the top level NOX directory, and let $NOX_BUILD
   denote the top level build directory (often these are the same).

   Within the $NOX_BUILD directory, type

   > configure [options]
   > make dox

   This will create the documentation inside the $NOX_SRC
   directory. Browse to $NOX_SRC/doc/html/index.html.


