diff options
author | Arun Isaac | 2021-07-04 18:43:34 +0530 |
---|---|---|
committer | Arun Isaac | 2021-07-04 19:38:22 +0530 |
commit | 53255a4d269a7e56626cba9b6c21b1c2d95e6c39 (patch) | |
tree | b3bc9c6660a7283d0758b7279fed2f705bd78b05 | |
parent | 8413e664c27bdbf55d6b0290466bc8beade7d8a2 (diff) | |
download | ccwl-53255a4d269a7e56626cba9b6c21b1c2d95e6c39.tar.gz ccwl-53255a4d269a7e56626cba9b6c21b1c2d95e6c39.tar.lz ccwl-53255a4d269a7e56626cba9b6c21b1c2d95e6c39.zip |
Makefile: Build skribilo documentation in-place.
* Makefile.am (SKRIBILO_BUILD_DIR): Delete variable.
(CLEANFILES): Add doc/*.cwl, doc/*.dot, doc/*.svg, doc/ccwl.info,
doc/skribilo.go.
($(SKRIBILO_BUILD_DIR)/%.cwl): Rename to %.cwl.
(info-local, install-info-local): Depend on doc/ccwl.info instead of
$(SKRIBILO_BUILD_DIR)/ccwl.info.
(html-local, install-html-local, website/manual/dev/en): Depend on
doc/ccwl.html instead of $(SKRIBILO_BUILD_DIR)/ccwl.html.
($(SKRIBILO_BUILD_DIR)/ccwl.info): Rename to doc/ccwl.info.
($(SKRIBILO_BUILD_DIR)/ccwl.html): Rename to doc/ccwl.html.
(clean-local): Do not delete doc/skribilo.go and
$(SKRIBILO_BUILD_DIR).
* .gitignore: Add doc/*.cwl, doc/*.html, doc/*.info, doc/*.svg. Remove
doc/skribilo.
* doc/ccwl.skb (Tutorial)[Workflow with multiple steps]: Reference
images in the doc directory instead of in the doc/skribilo directory.
-rw-r--r-- | .gitignore | 5 | ||||
-rw-r--r-- | Makefile.am | 30 | ||||
-rw-r--r-- | doc/ccwl.skb | 4 |
3 files changed, 21 insertions, 18 deletions
@@ -10,8 +10,11 @@ build-aux/test-driver.scm config.log config.status configure +doc/*.cwl +doc/*.html +doc/*.info +doc/*.svg doc/.dirstamp -doc/skribilo doc/stamp-vti pre-inst-env scripts/ccwl diff --git a/Makefile.am b/Makefile.am index d6305a8..afe3f34 100644 --- a/Makefile.am +++ b/Makefile.am @@ -89,7 +89,6 @@ EXTRA_DIST += \ # Build documentation -SKRIBILO_BUILD_DIR = $(srcdir)/doc/skribilo .depends: build-aux/find-dependencies.scm doc/ccwl.skb $(AM_V_GEN)$(top_builddir)/pre-inst-env $(GUILE) --no-auto-compile $< > $@ @@ -97,10 +96,10 @@ SKRIBILO_BUILD_DIR = $(srcdir)/doc/skribilo # We prefix with - so that automake does not fail when .depends is # missing. -include .depends +CLEANFILES += doc/*.cwl doc/%.dot doc/*.svg -$(SKRIBILO_BUILD_DIR)/%.cwl: doc/%.scm - $(MKDIR_P) $(SKRIBILO_BUILD_DIR) - $(CCWL_GEN)$(top_builddir)/pre-inst-env ccwl compile $< > $@ +%.cwl: %.scm + $(CCWL_GEN)$(builddir)/pre-inst-env ccwl compile $< > $@ # Print out graph for graphviz's dot, but remove file path prefix from # workflow step identifiers. @@ -113,14 +112,15 @@ $(SKRIBILO_BUILD_DIR)/%.cwl: doc/%.scm # The info and html targets depend on the info-local and html-local # targets respectively. So, we use them to extend the info and html # targets. -info-local: $(SKRIBILO_BUILD_DIR)/ccwl.info -html-local: $(SKRIBILO_BUILD_DIR)/ccwl.html +info-local: doc/ccwl.info +html-local: doc/ccwl.html -$(SKRIBILO_BUILD_DIR)/ccwl.info: doc/ccwl.skb doc/skribilo.go $(DOC_IMAGES) $(DOC_OTHER_DEPENDENCIES) - $(MKDIR_P) $(SKRIBILO_BUILD_DIR) +CLEANFILES += doc/ccwl.info doc/skribilo.go + +doc/ccwl.info: doc/ccwl.skb doc/skribilo.go $(DOC_IMAGES) $(DOC_OTHER_DEPENDENCIES) $(SKRIBILO_GEN)$(top_builddir)/pre-inst-env $(SKRIBILO) -t info $< -o $@ -$(SKRIBILO_BUILD_DIR)/ccwl.html: doc/ccwl.skb doc/skribilo.go $(DOC_IMAGES) $(DOC_OTHER_DEPENDENCIES) +doc/ccwl.html: doc/ccwl.skb doc/skribilo.go $(DOC_IMAGES) $(DOC_OTHER_DEPENDENCIES) rm -rf $@ $(MKDIR_P) $@ $(SKRIBILO_GEN)$(top_builddir)/pre-inst-env $(SKRIBILO) -t html $< -o $@/index.html @@ -134,13 +134,13 @@ install-data-local: install-info-local # The install-info and install-html targets depend on the # install-info-local and install-html-local targets respectively. Use # them to install the skribilo generated info and html documentation. -install-info-local: $(SKRIBILO_BUILD_DIR)/ccwl.info +install-info-local: doc/ccwl.info $(MKDIR_P) $(DESTDIR)$(infodir) - $(INSTALL_DATA) $(SKRIBILO_BUILD_DIR)/ccwl.info $(DESTDIR)$(infodir) + $(INSTALL_DATA) $< $(DESTDIR)$(infodir) -install-html-local: $(SKRIBILO_BUILD_DIR)/ccwl.html +install-html-local: doc/ccwl.html $(MKDIR_P) $(DESTDIR)$(htmldir) - $(INSTALL_DATA) $(SKRIBILO_BUILD_DIR)/ccwl.html $(DESTDIR)$(htmldir) + $(INSTALL_DATA) $< $(DESTDIR)$(htmldir) # The uninstall target depends on the uninstall-local target. Use it # to uninstall the installed info and html documentation. @@ -154,7 +154,7 @@ website: website/index.html website/manual/dev/en website/index.html: README.org $(EMACS_GEN)$(EMACS) -Q --script build-aux/build-home-page.el -website/manual/dev/en: $(SKRIBILO_BUILD_DIR)/ccwl.html +website/manual/dev/en: doc/ccwl.html rm -rf $@ $(MKDIR_P) $(dir $@) cp -vr $< $@ @@ -162,4 +162,4 @@ website/manual/dev/en: $(SKRIBILO_BUILD_DIR)/ccwl.html # The clean target depends on clean-local. Use clean-local to clean # up several artifacts not handled automatically by automake. clean-local: - rm -rf .depends doc/skribilo.go website/index.html website/manual $(SKRIBILO_BUILD_DIR) + rm -rf .depends website/index.html website/manual diff --git a/doc/ccwl.skb b/doc/ccwl.skb index 8fe4aea..5fa7b40 100644 --- a/doc/ccwl.skb +++ b/doc/ccwl.skb @@ -207,7 +207,7 @@ nothing to do with the Unix pipe. The inputs/outputs passed between steps are general CWL inputs/outputs. They need not be the standard stdin and stdout streams.]) - (image :file "doc/skribilo/decompress-compile-run.svg") + (image :file "doc/decompress-compile-run.svg") (p [Writing this worklow to ,(file "decompress-compile-run.scm"), compiling and running it with @@ -234,7 +234,7 @@ that are independent of each other. The workflow inputs coming into ,(code "tee"). The outputs of each step are collected together and unioned as the output of the ,(code "tee").]) - (image :file "doc/skribilo/checksum.svg") + (image :file "doc/checksum.svg") (p [Writing this workflow to ,(file "checksum.scm"), compiling and running it with some file ,(file "hello.txt") gives us the |