Skip to content

Add make targets to generate documentation #122

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wrp wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Add make targets to generate documentation #122

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 23 additions & 2 deletions Makefile.am
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
##
## Author: B.Irby (NASA/GSFC), based on the previous CFITSIO Makefile.in

VPATH = $(srcdir) $(srcdir)/docs

lib_LTLIBRARIES = libcfitsio.la

# Dummary library to compile single object file with SSE flags
Expand Down Expand Up @@ -193,7 +195,7 @@ eval: # Rebuild eval_* files from flex/bison source


EXTRA_DIST = $(F77_WRAPPERS) ${GSIFTP_SRC} \
docs licenses \
licenses \
README.md README.MacOS README.win \
cfitsio.pc.cmake cfitsio.pc.in \
cfitsio.xcodeproj \
Expand All @@ -204,6 +206,9 @@ EXTRA_DIST = $(F77_WRAPPERS) ${GSIFTP_SRC} \
sample.tpl \
testf77.out testf77.std \
testprog.out testprog.std testprog.tpt \
docs/cfitsio.tex \
docs/fitsio.tex \
docs/quick.tex \
utilities/fitsverify.c
# windumpexts.c
# winDumpExts.mak
Expand All @@ -215,7 +220,11 @@ AM_TESTS_ENVIRONMENT = srcdir='$(srcdir)'

# clean: =================================================================

CLEANFILES = testprog.fit testprog.lis testf77.fit atestfil.fit btestfil.fit y.output
CLEANFILES = testprog.fit testprog.lis testf77.fit atestfil.fit btestfil.fit y.output \
cfitsio.pdf cfitsio.aux cfitsio.log cfitsio.out cfitsio.toc \
fitsio.pdf fitsio.aux fitsio.log fitsio.out fitsio.toc \
quick.pdf quick.aux quick.log quick.out quick.toc \
fpackguide.pdf

# HEASoft packages fitsTcl and POW need a list of all .o files: ==========

Expand All @@ -224,3 +233,15 @@ cfitsioLibObjs:

# Empty rule to prevent GNU Make's builtin from overwriting sample test output
%.out: %

# Generate .pdf files from .tex
.tex.pdf:
TEXINPUTS="$(srcdir)/docs:$$TEXINPUTS" pdflatex $<
TEXINPUTS="$(srcdir)/docs:$$TEXINPUTS" pdflatex $< # run twice for references

# Generate .pdf files from .md
.md.pdf:
pandoc $< -V linkcolor=blue -o $@

.PHONY: doc
doc: cfitsio.pdf fitsio.pdf quick.pdf fpackguide.pdf
28 changes: 24 additions & 4 deletions Makefile.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@



VPATH = @srcdir@
am__is_gnu_make = { \
if test -z '$(MAKELEVEL)'; then \
false; \
Expand Down Expand Up @@ -657,6 +656,7 @@ am__distuninstallcheck_listfiles = $(distuninstallcheck_listfiles) \
distcleancheck_listfiles = \
find . \( -type f -a \! \
\( -name .nfs* -o -name .smb* -o -name .__afs* \) \) -print
VPATH = $(srcdir) $(srcdir)/docs
ACLOCAL = @ACLOCAL@
AMTAR = @AMTAR@
AM_DEFAULT_VERBOSITY = @AM_DEFAULT_VERBOSITY@
Expand Down Expand Up @@ -864,7 +864,7 @@ BISON = bison

# Distribution: ==========================================================
EXTRA_DIST = $(F77_WRAPPERS) ${GSIFTP_SRC} \
docs licenses \
licenses \
README.md README.MacOS README.win \
cfitsio.pc.cmake cfitsio.pc.in \
cfitsio.xcodeproj \
Expand All @@ -875,6 +875,9 @@ EXTRA_DIST = $(F77_WRAPPERS) ${GSIFTP_SRC} \
sample.tpl \
testf77.out testf77.std \
testprog.out testprog.std testprog.tpt \
docs/cfitsio.tex \
docs/fitsio.tex \
docs/quick.tex \
utilities/fitsverify.c

# windumpexts.c
Expand All @@ -885,11 +888,16 @@ TESTS = run-testprog
AM_TESTS_ENVIRONMENT = srcdir='$(srcdir)'

# clean: =================================================================
CLEANFILES = testprog.fit testprog.lis testf77.fit atestfil.fit btestfil.fit y.output
CLEANFILES = testprog.fit testprog.lis testf77.fit atestfil.fit btestfil.fit y.output \
cfitsio.pdf cfitsio.aux cfitsio.log cfitsio.out cfitsio.toc \
fitsio.pdf fitsio.aux fitsio.log fitsio.out fitsio.toc \
quick.pdf quick.aux quick.log quick.out quick.toc \
fpackguide.pdf

all: all-am

.SUFFIXES:
.SUFFIXES: .c .f .lo .log .o .obj .test .test$(EXEEXT) .trs
.SUFFIXES: .c .f .lo .log .md .o .obj .pdf .test .test$(EXEEXT) .tex .trs
am--refresh: Makefile
@:
$(srcdir)/Makefile.in: @MAINTAINER_MODE_TRUE@ $(srcdir)/Makefile.am $(am__configure_deps)
Expand Down Expand Up @@ -2605,6 +2613,18 @@ cfitsioLibObjs:
# Empty rule to prevent GNU Make's builtin from overwriting sample test output
%.out: %

# Generate .pdf files from .tex
.tex.pdf:
TEXINPUTS="$(srcdir)/docs:$$TEXINPUTS" pdflatex $<
TEXINPUTS="$(srcdir)/docs:$$TEXINPUTS" pdflatex $< # run twice for references

# Generate .pdf files from .md
.md.pdf:
pandoc $< -V linkcolor=blue -o $@

.PHONY: doc
doc: cfitsio.pdf fitsio.pdf quick.pdf fpackguide.pdf

# Tell versions [3.59,3.63) of GNU make to not export all variables.
# Otherwise a system limit (for SysV at least) may be exceeded.
.NOEXPORT:
Expand Down