diff options
| author | rsiddharth <s@ricketyspace.net> | 2016-07-11 02:03:20 +0000 |
|---|---|---|
| committer | rsiddharth <s@ricketyspace.net> | 2016-07-11 02:03:20 +0000 |
| commit | 2ea195dfbc4da32cbf729fe4f4515849e4ebbd97 (patch) | |
| tree | 32ec668c3ea4057a79dff527f2eb208ba259b996 | |
| parent | 8845d6ed54c93957227c34b22c909b475ed38baf (diff) | |
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.
| -rw-r--r-- | .gitignore | 3 | ||||
| -rw-r--r-- | Makefile | 17 | ||||
| -rw-r--r-- | docs/Makefile | 32 | ||||
| -rw-r--r-- | docs/assets/includes/footer.html | 2 | ||||
| -rw-r--r-- | docs/assets/includes/header.html | 9 |
5 files changed, 61 insertions, 2 deletions
@@ -1 +1,2 @@ -*~
\ No newline at end of file +*~ +docs/_build/
\ No newline at end of file @@ -1,4 +1,4 @@ -#!/usr/bin/make +#!/usr/bin/env make # license: gnu gpl version 3 or higher. # copyright 2016 rsiddharth <s@ricketyspace.net> @@ -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 <s@ricketyspace.net> + +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 @@ +</body> +</html> 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 @@ +<!DOCTYPE html> +<head> + <meta charset="UTF-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <meta name="author" content=" rsiddharth"> + <title>ricketyspace.net - git-difme</title> + <style>body {font-size:12px;}</style> +</head> +<body> |