2010-06-03 21:24:43 +08:00
|
|
|
## This is a automake file, part of Unidata's netCDF package.
|
2011-08-22 21:53:37 +08:00
|
|
|
# Copyright 2005-2011, see the COPYRIGHT file for more information.
|
2010-06-03 21:24:43 +08:00
|
|
|
# This file builds the netcdf documentation.
|
|
|
|
|
2012-03-15 07:26:48 +08:00
|
|
|
|
2010-06-03 21:24:43 +08:00
|
|
|
# These files will be included with the dist.
|
2012-03-15 07:26:48 +08:00
|
|
|
EXTRA_DIST = netcdf.m4 DoxygenLayout.xml Doxyfile.in footer.html \
|
2015-04-17 06:44:51 +08:00
|
|
|
mainpage.dox tutorial.dox dispatch.dox \
|
|
|
|
guide.dox types.dox cdl.dox \
|
2014-03-07 06:56:32 +08:00
|
|
|
architecture.dox internal.dox windows-binaries.md \
|
2014-05-13 00:43:01 +08:00
|
|
|
building-with-cmake.md CMakeLists.txt \
|
2015-04-17 06:44:51 +08:00
|
|
|
groups.dox install.md notes.md install-fortran.md \
|
2017-06-08 02:58:23 +08:00
|
|
|
all-error-codes.md cmake_faq.md credits.md \
|
2016-05-10 10:32:42 +08:00
|
|
|
auth.html obsolete/fan_utils.html bestpractices.md
|
2010-06-03 21:24:43 +08:00
|
|
|
|
|
|
|
# Turn off parallel builds in this directory.
|
|
|
|
.NOTPARALLEL:
|
|
|
|
|
|
|
|
# To build documentation you must have M4 in their path.
|
|
|
|
M4=m4
|
|
|
|
|
2011-08-22 21:53:37 +08:00
|
|
|
SUBDIRS = images
|
2010-06-03 21:24:43 +08:00
|
|
|
|
2011-08-22 21:53:37 +08:00
|
|
|
if BUILD_DOCS
|
2010-06-03 21:24:43 +08:00
|
|
|
|
2011-08-22 21:53:37 +08:00
|
|
|
# Copy man pages.
|
2011-08-11 02:00:32 +08:00
|
|
|
#directory = $(top_srcdir)/docs/man/man3/
|
2014-05-22 04:40:39 +08:00
|
|
|
#dist_man_MANS = $(docsdirectory)/man_page_1.3 $(directory)/man_page_2.3
|
2011-07-21 05:39:14 +08:00
|
|
|
# $(directory)/man_page_1.3: doxyfile.stamp
|
|
|
|
# $(directory)/man_page_2.3: doxyfile.stamp
|
|
|
|
|
2012-03-15 07:26:48 +08:00
|
|
|
# Note: in order to work with distcheck,
|
|
|
|
# the Doxyfile needs to be preprocessed
|
|
|
|
# to insert actual location of $(srcdir)
|
|
|
|
#BUILT_SOURCES = Doxyfile.tmp
|
|
|
|
|
|
|
|
#Doxyfile.tmp: Doxyfile
|
|
|
|
# sed -e 's|$$[({]rootdir[})]|$(abs_top_srcdir)|g' <Doxyfile > ./Doxyfile.tmp
|
|
|
|
|
2011-08-11 02:00:32 +08:00
|
|
|
all-local: doxyfile.stamp
|
|
|
|
clean-local:
|
2014-05-22 04:40:39 +08:00
|
|
|
rm -rf $(top_builddir)/docs/man
|
|
|
|
rm -rf $(top_builddir)/docs/html
|
|
|
|
rm -rf $(top_builddir)/docs/latex
|
2014-09-04 02:33:52 +08:00
|
|
|
endif
|
2012-06-18 08:53:50 +08:00
|
|
|
|
|
|
|
# Timestamp to prevent rebuilds.
|
2014-05-30 04:07:45 +08:00
|
|
|
# We must do this twice. The first time
|
|
|
|
# builds the tag files. The second time
|
|
|
|
# includes them in the documentation.
|
|
|
|
|
2012-06-18 08:53:50 +08:00
|
|
|
doxyfile.stamp:
|
2015-10-28 08:23:54 +08:00
|
|
|
$(DOXYGEN) Doxyfile \
|
2016-01-20 07:15:51 +08:00
|
|
|
cp auth.html obsolete/fan_utils.html html
|
2012-06-18 08:53:50 +08:00
|
|
|
|
|
|
|
CLEANFILES = doxyfile.stamp html latex man
|
2011-08-22 21:53:37 +08:00
|
|
|
|
|
|
|
# This builds the docs from source, if necessary, and tars up
|
|
|
|
# everything needed for the website. Run this and copy the resulting
|
|
|
|
# tarball to the /contents/netcdf/docs directory to update the on-line
|
|
|
|
# docs.
|
|
|
|
web-tarball: doxyfile.stamp
|
2012-01-03 01:31:23 +08:00
|
|
|
cd html; tar cf ../netcdf_docs.tar *
|
2011-08-22 22:04:39 +08:00
|
|
|
gzip -f netcdf_docs.tar
|
2015-10-25 11:45:13 +08:00
|
|
|
|
|
|
|
# When oc2/auth.html.in is changed, you should generate auth.html
|
|
|
|
# using the following process.
|
2015-10-28 08:23:54 +08:00
|
|
|
oc2-auth:
|
2015-10-25 11:45:13 +08:00
|
|
|
cat ${top_srcdir}/oc2/auth.html.in \
|
|
|
|
| sed -e '/<OC>/d' \
|
|
|
|
| sed -e 's|^<NC>||' \
|
|
|
|
| sed -e 's|zz|netcdf|g' -e 's|ZZ|netCDF|g' \
|
|
|
|
| sed -e '/stylesheet/r${top_srcdir}/oc2/oc.css' -e '/stylesheet/d' \
|
2015-10-28 08:23:54 +08:00
|
|
|
> auth.html
|