From f2290993a37d48e1e4d41d6ba5617a966934b254 Mon Sep 17 00:00:00 2001 From: Ian Jackson Date: Wed, 28 Sep 2022 19:34:05 +0100 Subject: [PATCH] docs installation code Copied some of the Makefile from my own code in the Otter Makefile. Signed-off-by: Ian Jackson --- Makefile | 17 +++++++++++++++++ docs/colophon.md | 19 +++++++++++++++++++ docs/index.rst | 1 + 3 files changed, 37 insertions(+) create mode 100644 docs/colophon.md diff --git a/Makefile b/Makefile index ffb76d8..3219c50 100644 --- a/Makefile +++ b/Makefile @@ -78,4 +78,21 @@ clean: very-clean: clean $(CARGO) clean +#---------- docs publication ---------- + +PUBLISHED_BRANCH=published +PUBLISH_VERSION=unreleased +PUBLISH_USER=ianmdlvl@login.chiark.greenend.org.uk +PUBLISH_DOC_SPHINX_BASE=public-html/hippotat +PUBLISH_DOC_SPHINX_TAIL=$(PUBLISH_VERSION)/docs +PUBLISH_DOC_SPHINX=$(PUBLISH_USER):$(PUBLISH_DOC_SPHINX_BASE)/$(PUBLISH_DOC_SPHINX_TAIL) + +publish: doc + ssh $(PUBLISH_USER) 'cd $(PUBLISH_DOC_SPHINX_BASE) && mkdir -p $(PUBLISH_DOC_SPHINX_TAIL)' + rsync -r --delete-delay docs/html/. $(PUBLISH_DOC_SPHINX)/. + git branch -f $(PUBLISHED_BRANCH) + +publish-make-current: + ssh $(PUBLISH_USER) 'set -e; cd $(PUBLISH_DOC_SPHINX_BASE); rm -f current.tmp; ln -s $(PUBLISH_VERSION) current.tmp; mv -T current.tmp current' + .PHONY: cargo-build all doc clean diff --git a/docs/colophon.md b/docs/colophon.md new file mode 100644 index 0000000..324f175 --- /dev/null +++ b/docs/colophon.md @@ -0,0 +1,19 @@ +Colophon +======== + +Hippotat is Copyright 2017-2022 Ian Jackson +and contributors. + +Hippotat is released under the GNU GPLv3+ +with an OpenSSL linking exception. +See the file `COPYING` in the source tree +for the full licence text. +There is NO WARRANTY. + +The +[Documentation for the current version](https://www.chiark.greenend.org.uk/~ianmdlvl/hippotat/current/docs/) +is online, +as well as [for earlier versons](https://www.chiark.greenend.org.uk/~ianmdlvl/hippotat/). + +[Hippotat's source repository](https://salsa.debian.org/iwj/hippotat) +is hosted on Debian Salsa. diff --git a/docs/index.rst b/docs/index.rst index e91ff70..921232c 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -9,6 +9,7 @@ Hippotat - Asinine IP over HTTP install.md config.md settings.md + colophon.md Indices and tables ================== -- 2.30.2