From 2ea195dfbc4da32cbf729fe4f4515849e4ebbd97 Mon Sep 17 00:00:00 2001 From: rsiddharth Date: Mon, 11 Jul 2016 02:03:20 +0000 Subject: add stuff to generate docs. * .gitignore: ignore docs/_build directory. * Makefile (docs, push-docs, docs-clean): new targets. * docs/Makefile: new file * docs/assets/includes/header.html: new file. * docs/assets/includes/footer.html: new file. --- .gitignore | 3 ++- Makefile | 17 ++++++++++++++++- docs/Makefile | 32 ++++++++++++++++++++++++++++++++ docs/assets/includes/footer.html | 2 ++ docs/assets/includes/header.html | 9 +++++++++ 5 files changed, 61 insertions(+), 2 deletions(-) create mode 100644 docs/Makefile create mode 100644 docs/assets/includes/footer.html create mode 100644 docs/assets/includes/header.html diff --git a/.gitignore b/.gitignore index e4e5f6c..4276630 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,2 @@ -*~ \ No newline at end of file +*~ +docs/_build/ \ No newline at end of file diff --git a/Makefile b/Makefile index 75c852b..a8461d8 100644 --- a/Makefile +++ b/Makefile @@ -1,4 +1,4 @@ -#!/usr/bin/make +#!/usr/bin/env make # license: gnu gpl version 3 or higher. # copyright 2016 rsiddharth @@ -26,6 +26,21 @@ config: $(config_file) .PHONY: config +docs: + @make -C docs html + +.PHONY: docs + +push-docs: docs + @rsync -avz --delete docs/_build/ $(DIFME_DOCS_HOST) + +.PHONY: push-docs + +docs-clean: + @make -C docs clean + +.PHONY: docs-clean + $(git_difme): $(git_difme_src) @mkdir -p $(bin) @touch $@ diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..68c953e --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,32 @@ +#!/usr/bin/env make +# license: gnu gpl version 3 or higher. +# copyright 2016 rsiddharth + +build_dir=_build + +# docs +header=assets/includes/header.html +footer=assets/includes/footer.html + +index_src=index.org +index_out=$(build_dir)/index.html + +nothing: + @echo "Give me something to make. " + +html: $(index_out) + +.PHONY: html + +$(build_dir): + @mkdir $@ + +$(index_out): $(index_src) $(header) $(footer) $(build_dir) + @cat $(header) > $@ + @pandoc -f org -t html $< >> $@ + @cat $(footer) >> $@ + +clean: $(build_dir) + @rm -rf $< + +.PHONY: clean diff --git a/docs/assets/includes/footer.html b/docs/assets/includes/footer.html new file mode 100644 index 0000000..308b1d0 --- /dev/null +++ b/docs/assets/includes/footer.html @@ -0,0 +1,2 @@ + + diff --git a/docs/assets/includes/header.html b/docs/assets/includes/header.html new file mode 100644 index 0000000..7fe7be1 --- /dev/null +++ b/docs/assets/includes/header.html @@ -0,0 +1,9 @@ + + + + + + ricketyspace.net - git-difme + + + -- cgit v1.2.3