Skip to content

Commit

Permalink
Revert "Remove build recipes, now included in main repository"
Browse files Browse the repository at this point in the history
This reverts commit d831ff8.
  • Loading branch information
giacomofiorin committed Oct 18, 2023
1 parent c068113 commit 096089a
Show file tree
Hide file tree
Showing 7 changed files with 2,846 additions and 0 deletions.
141 changes: 141 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,141 @@
# This is slightly convoluted as it makes the PDF doc in a separate dir and copies them
# The HTML doc is made from within that dir, targeting this one

# Safe order of operations: make clean; make pdf; make html

DOCDIR=$(PWD)
ifeq ($(COLVARSDIR),)
COLVARSDIR=$(PWD)/../colvars
endif
SRCDIR=$(COLVARSDIR)/src
DOCSRCDIR=$(COLVARSDIR)/doc
PDFDIR=pdf
PDF=$(PDFDIR)/colvars-refman-gromacs.pdf \
$(PDFDIR)/colvars-refman-lammps.pdf \
$(PDFDIR)/colvars-refman-namd.pdf \
$(PDFDIR)/colvars-refman-vmd.pdf \
vmd-1.9.4/$(PDFDIR)/colvars-refman-vmd.pdf \
namd-2.15/$(PDFDIR)/colvars-refman-namd.pdf \


BIBTEX=$(DOCSRCDIR)/colvars-refman.bib
HTML=colvars-refman-gromacs/colvars-refman-gromacs.html \
colvars-refman-lammps/colvars-refman-lammps.html \
colvars-refman-namd/colvars-refman-namd.html \
colvars-refman-vmd/colvars-refman-vmd.html \
vmd-1.9.4/colvars-refman-vmd/colvars-refman-vmd.html \
namd-2.15/colvars-refman-namd/colvars-refman-namd.html \


IMAGES = cover-512px.jpg eulerangles-512px.png

# Check that we are updating the doc for the master branch
branch := $(shell git -C $(DOCSRCDIR) symbolic-ref --short -q HEAD)
ifneq ($(FORCE), 1)
ifneq ($(branch), master)
$(error Source repo has branch $(branch) checked out, instead of master. Use FORCE=1 to override)
endif
endif

.PHONY: all clean veryclean doxygen readme images update

all: images pdf html doxygen readme

images:
make -C images all; \
cp -p -f $(addprefix $(DOCDIR)/images/, $(IMAGES)) $(DOCSRCDIR)/

pdf: $(PDF)

html: $(HTML)

readme: $(COLVARSDIR)/README.md $(COLVARSDIR)/README-totalforce.md $(COLVARSDIR)/README-c++11.md
cp -p -f $^ ./

$(PDFDIR)/%.pdf: $(DOCSRCDIR)/%.tex $(BIBTEX) $(DOCSRCDIR)/colvars-refman-main.tex $(DOCSRCDIR)/colvars-refman.tex
make -C $(DOCSRCDIR) pdf
cp -p -f $(DOCSRCDIR)/`basename $@` $(PDFDIR)

HTLATEX = htlatex
HTLATEX_OPTS = "html5mjlatex.cfg, charset=utf-8" " -cunihtf -utf8"

# Note: this relies on up-to-date bbl files; run pdflatex first!
colvars-refman-namd/colvars-refman-namd.html: $(BIBTEX) $(PDF) $(DOCSRCDIR)/colvars-refman-main.tex $(DOCSRCDIR)/colvars-refman.tex $(DOCSRCDIR)/colvars-refman-namd.tex
cd $(DOCSRCDIR); \
cp -p -f $(DOCDIR)/html5mjlatex.cfg ./ ; \
$(HTLATEX) colvars-refman-namd.tex $(HTLATEX_OPTS) "-d$(DOCDIR)/colvars-refman-namd/"; \
rm -f html5mjlatex.cfg; \
cd $(DOCDIR)/colvars-refman-namd; \
cp -p -f $(addprefix $(DOCDIR)/images/, $(IMAGES)) ./ ; \
../postprocess_html.sh

colvars-refman-vmd/colvars-refman-vmd.html: $(BIBTEX) $(PDF) $(DOCSRCDIR)/colvars-refman-main.tex $(DOCSRCDIR)/colvars-refman.tex $(DOCSRCDIR)/colvars-refman-vmd.tex
cd $(DOCSRCDIR); \
cp -p -f $(DOCDIR)/html5mjlatex.cfg ./ ; \
$(HTLATEX) colvars-refman-vmd.tex $(HTLATEX_OPTS) "-d$(DOCDIR)/colvars-refman-vmd/"; \
rm -f html5mjlatex.cfg; \
cd $(DOCDIR)/colvars-refman-vmd; \
cp -p -f $(addprefix $(DOCDIR)/images/, $(IMAGES)) ./ ; \
../postprocess_html.sh

vmd-1.9.4/colvars-refman-vmd/colvars-refman-vmd.html: colvars-refman-vmd/colvars-refman-vmd.html colvars-refman-vmd/colvars-refman-vmd.css
cp -p -f $^ $(dir $@); \
cp -p -f $(addprefix $(DOCDIR)/images/, $(IMAGES)) vmd-1.9.4/colvars-refman-vmd/

vmd-1.9.4/pdf/colvars-refman-vmd.pdf: pdf/colvars-refman-vmd.pdf
cp -p -f $^ $@

namd-2.15/colvars-refman-namd/colvars-refman-namd.html: colvars-refman-namd/colvars-refman-namd.html colvars-refman-namd/colvars-refman-namd.css
cp -p -f $^ $(dir $@); \
cp -p -f $(addprefix $(DOCDIR)/images/, $(IMAGES)) namd-2.15/colvars-refman-namd/

namd-2.15/pdf/colvars-refman-namd.pdf: pdf/colvars-refman-namd.pdf
cp -p -f $^ $@

colvars-refman-lammps/colvars-refman-lammps.html: $(BIBTEX) $(PDF) $(DOCSRCDIR)/colvars-refman-main.tex $(DOCSRCDIR)/colvars-refman.tex $(DOCSRCDIR)/colvars-refman-lammps.tex
cd $(DOCSRCDIR); \
cp -p -f $(DOCDIR)/html5mjlatex.cfg ./ ; \
$(HTLATEX) colvars-refman-lammps.tex $(HTLATEX_OPTS) "-d$(DOCDIR)/colvars-refman-lammps/"; \
rm -f html5mjlatex.cfg; \
cd $(DOCDIR)/colvars-refman-lammps; \
cp -p -f $(addprefix $(DOCDIR)/images/, $(IMAGES)) ./ ; \
../postprocess_html.sh

colvars-refman-gromacs/colvars-refman-gromacs.html: $(BIBTEX) $(PDF) $(DOCSRCDIR)/colvars-refman-main.tex $(DOCSRCDIR)/colvars-refman.tex $(DOCSRCDIR)/colvars-refman-gromacs.tex
cd $(DOCSRCDIR); \
cp -p -f $(DOCDIR)/html5mjlatex.cfg ./ ; \
$(HTLATEX) colvars-refman-gromacs.tex $(HTLATEX_OPTS) "-d$(DOCDIR)/colvars-refman-gromacs/"; \
rm -f html5mjlatex.cfg; \
cd $(DOCDIR)/colvars-refman-gromacs; \
cp -p -f $(addprefix $(DOCDIR)/images/, $(IMAGES)) ./ ; \
../postprocess_html.sh


multi-map/multi-map.pdf: multi-map.src/multi-map.tex
cd multi-map.src; \
make; \
cp -p -f multi-map.pdf $(DOCDIR)/multi-map/

multi-map/multi-map.html: multi-map/multi-map.pdf multi-map.src/multi-map.tex
cd multi-map.src; \
cp -p -f $(DOCDIR)/html5mjlatex.cfg $(DOCSRCDIR)/colvars-refman-css.tex ./ ; \
$(HTLATEX) multi-map.tex $(HTLATEX_OPTS) "-d$(DOCDIR)/multi-map/"; \
rm -f html5mjlatex.cfg colvars-refman-css.tex; \
cd $(DOCDIR)/multi-map; \
../postprocess_html.sh


doxygen: doxygen/html/index.html

doxygen/html/index.html: $(SRCDIR)/*.h doxygen/Doxyfile
cd doxygen; doxygen

clean:
make -C $(DOCSRCDIR) clean

veryclean: clean
rm -f $(PDF) colvars-refman-namd/* colvars-refman-vmd/* colvars-refman-lammps/* colvars-refman-gromacs/*

update: all
git add . && git commit -m "Update doc" && git push origin master

137 changes: 137 additions & 0 deletions Makefile.tinker
Original file line number Diff line number Diff line change
@@ -0,0 +1,137 @@
# This is slightly convoluted as it makes the PDF doc in a separate dir and copies them
# The HTML doc is made from within that dir, targeting this one

# Safe order of operations: make clean; make pdf; make html

DOCDIR=$(PWD)
COLVARSDIR=$(PWD)/../colvars
#COLVARSDIR=$(PWD)/../colvars-master
SRCDIR=$(COLVARSDIR)/src
DOCSRCDIR=$(COLVARSDIR)/doc
PDFDIR=pdf
PDF=$(PDFDIR)/colvars-refman-gromacs.pdf \
$(PDFDIR)/colvars-refman-tinkerhp.pdf \
$(PDFDIR)/colvars-refman-lammps.pdf \
$(PDFDIR)/colvars-refman-namd.pdf \
$(PDFDIR)/colvars-refman-vmd.pdf \
vmd-1.9.4/$(PDFDIR)/colvars-refman-vmd.pdf

BIBTEX=$(DOCSRCDIR)/colvars-refman.bib
HTML=colvars-refman-gromacs/colvars-refman-gromacs.html \
colvars-refman-tinkerhp/colvars-refman-tinkerhp.html \
colvars-refman-lammps/colvars-refman-lammps.html \
colvars-refman-namd/colvars-refman-namd.html \
colvars-refman-vmd/colvars-refman-vmd.html \
vmd-1.9.4/colvars-refman-vmd/colvars-refman-vmd.html

IMAGES = cover-512px.jpg eulerangles-512px.png

# Check that we are updating the doc for the master branch
branch := $(shell git -C $(DOCSRCDIR) symbolic-ref --short -q HEAD)
ifneq ($(FORCE), 1)
ifneq ($(branch), master)
$(error Source repo has branch $(branch) checked out, instead of master. Use FORCE=1 to override)
endif
endif

.PHONY: all clean veryclean doxygen readme images

all: images pdf html doxygen readme

images:
make -C images all; \
cp -p -f $(addprefix $(DOCDIR)/images/, $(IMAGES)) $(DOCSRCDIR)/

pdf: $(PDF)

html: $(HTML)

readme: $(COLVARSDIR)/README.md $(COLVARSDIR)/README-totalforce.md $(COLVARSDIR)/README-c++11.md
cp -p -f $^ ./

$(PDFDIR)/%.pdf: $(DOCSRCDIR)/%.tex $(BIBTEX) $(DOCSRCDIR)/colvars-refman-main.tex $(DOCSRCDIR)/colvars-refman.tex
make -C $(DOCSRCDIR) pdf
mv -f $(DOCSRCDIR)/`basename $@` $(PDFDIR)
make -C $(DOCSRCDIR) clean

HTLATEX = htlatex
HTLATEX_OPTS = "html5mjlatex.cfg, charset=utf-8" " -cunihtf -utf8"

# Note: this relies on up-to-date bbl files; run pdflatex first!
colvars-refman-namd/colvars-refman-namd.html: $(BIBTEX) $(PDF) $(DOCSRCDIR)/colvars-refman-main.tex $(DOCSRCDIR)/colvars-refman.tex $(DOCSRCDIR)/colvars-refman-namd.tex
cd $(DOCSRCDIR); \
cp -p -f $(DOCDIR)/html5mjlatex.cfg ./ ; \
$(HTLATEX) colvars-refman-namd.tex $(HTLATEX_OPTS) "-d$(DOCDIR)/colvars-refman-namd/"; \
rm -f html5mjlatex.cfg; \
cd $(DOCDIR)/colvars-refman-namd; \
cp -p -f $(addprefix $(DOCDIR)/images/, $(IMAGES)) ./ ; \
sh ../postprocess_html.sh

colvars-refman-vmd/colvars-refman-vmd.html: $(BIBTEX) $(PDF) $(DOCSRCDIR)/colvars-refman-main.tex $(DOCSRCDIR)/colvars-refman.tex $(DOCSRCDIR)/colvars-refman-vmd.tex
cd $(DOCSRCDIR); \
cp -p -f $(DOCDIR)/html5mjlatex.cfg ./ ; \
$(HTLATEX) colvars-refman-vmd.tex $(HTLATEX_OPTS) "-d$(DOCDIR)/colvars-refman-vmd/"; \
rm -f html5mjlatex.cfg; \
cd $(DOCDIR)/colvars-refman-vmd; \
cp -p -f $(addprefix $(DOCDIR)/images/, $(IMAGES)) ./ ; \
sh ../postprocess_html.sh

vmd-1.9.4/colvars-refman-vmd/colvars-refman-vmd.html: colvars-refman-vmd/colvars-refman-vmd.html
cp -p -f $^ $@; \
cp -p -f $(addprefix $(DOCDIR)/images/, $(IMAGES)) vmd-1.9.4/colvars-refman-vmd/

vmd-1.9.4/pdf/colvars-refman-vmd.pdf: pdf/colvars-refman-vmd.pdf
cp -p -f $^ $@

colvars-refman-lammps/colvars-refman-lammps.html: $(BIBTEX) $(PDF) $(DOCSRCDIR)/colvars-refman-main.tex $(DOCSRCDIR)/colvars-refman.tex $(DOCSRCDIR)/colvars-refman-lammps.tex
cd $(DOCSRCDIR); \
cp -p -f $(DOCDIR)/html5mjlatex.cfg ./ ; \
$(HTLATEX) colvars-refman-lammps.tex $(HTLATEX_OPTS) "-d$(DOCDIR)/colvars-refman-lammps/"; \
rm -f html5mjlatex.cfg; \
cd $(DOCDIR)/colvars-refman-lammps; \
cp -p -f $(addprefix $(DOCDIR)/images/, $(IMAGES)) ./ ; \
sh ../postprocess_html.sh

colvars-refman-gromacs/colvars-refman-gromacs.html: $(BIBTEX) $(PDF) $(DOCSRCDIR)/colvars-refman-main.tex $(DOCSRCDIR)/colvars-refman.tex $(DOCSRCDIR)/colvars-refman-gromacs.tex
cd $(DOCSRCDIR); \
cp -p -f $(DOCDIR)/html5mjlatex.cfg ./ ; \
$(HTLATEX) colvars-refman-gromacs.tex $(HTLATEX_OPTS) "-d$(DOCDIR)/colvars-refman-gromacs/"; \
rm -f html5mjlatex.cfg; \
cd $(DOCDIR)/colvars-refman-gromacs; \
cp -p -f $(addprefix $(DOCDIR)/images/, $(IMAGES)) ./ ; \
sh ../postprocess_html.sh

colvars-refman-tinkerhp/colvars-refman-tinkerhp.html: $(BIBTEX) $(PDF) $(DOCSRCDIR)/colvars-refman-main.tex $(DOCSRCDIR)/colvars-refman.tex $(DOCSRCDIR)/colvars-refman-tinkerhp.tex
cd $(DOCSRCDIR); \
cp -p -f $(DOCDIR)/html5mjlatex.cfg ./ ; \
$(HTLATEX) colvars-refman-tinkerhp.tex $(HTLATEX_OPTS) "-d$(DOCDIR)/colvars-refman-tinkerhp/"; \
rm -f html5mjlatex.cfg; \
cd $(DOCDIR)/colvars-refman-tinkerhp; \
cp -p -f $(addprefix $(DOCDIR)/images/, $(IMAGES)) ./ ; \
sh ../postprocess_html.sh

multi-map/multi-map.pdf: multi-map.src/multi-map.tex
cd multi-map.src; \
make; \
cp -p -f multi-map.pdf $(DOCDIR)/multi-map/

multi-map/multi-map.html: multi-map/multi-map.pdf multi-map.src/multi-map.tex
cd multi-map.src; \
cp -p -f $(DOCDIR)/html5mjlatex.cfg $(DOCSRCDIR)/colvars-refman-css.tex ./ ; \
$(HTLATEX) multi-map.tex $(HTLATEX_OPTS) "-d$(DOCDIR)/multi-map/"; \
rm -f html5mjlatex.cfg colvars-refman-css.tex; \
cd $(DOCDIR)/multi-map; \
sh ../postprocess_html.sh


doxygen: doxygen/html/index.html

doxygen/html/index.html: $(SRCDIR)/*.h doxygen/Doxyfile
cd doxygen; doxygen

clean:
make -C $(DOCSRCDIR) clean

veryclean: clean
rm -f $(PDF) colvars-refman-namd/* colvars-refman-vmd/* colvars-refman-lammps/* colvars-refman-gromacs/* colvars-refman-tinkerhp/*

Loading

0 comments on commit 096089a

Please sign in to comment.