From 90ffb733c25a6a536da05f51e4650b43b8fb13ac Mon Sep 17 00:00:00 2001 From: Drup Date: Fri, 6 Mar 2020 14:43:07 +0100 Subject: [PATCH] tooling for wikidoc. --- .gitignore | 1 + Makefile | 25 ++++++++++++++++++++++--- docs/Makefile | 11 +++++------ docs/RELEASE.md | 21 +++++++++++++++++---- 4 files changed, 45 insertions(+), 13 deletions(-) diff --git a/.gitignore b/.gitignore index 04dfe4dea..2e9f907ac 100644 --- a/.gitignore +++ b/.gitignore @@ -16,3 +16,4 @@ _tests *.install docs/api/ _opam +_wikidoc diff --git a/Makefile b/Makefile index d1221caeb..5c355bcfe 100644 --- a/Makefile +++ b/Makefile @@ -22,6 +22,25 @@ clean: doc: dune build @doc -.PHONY: doc-api-wiki -wikidoc: build - make -C doc wikidoc +# WIKIDOC stuff +# Should have wikidoc installed with +# opam pin add https://github.com/ocsigen/wikidoc.git + +DOCDIR=_wikidoc + +$(DOCDIR)/.git: + mkdir -p $(DOCDIR) + cd $(DOCDIR) && (\ + git clone -b wikidoc git@github.com:ocsigen/tyxml.git . \ + ) + +.PHONY: doc wikidoc +wikidoc: build $(DOCDIR)/.git + make -C docs wikidoc; exit 0 + rm -rf _wikidoc/docs/dev/* + cp -r docs/api/wiki _wikidoc/docs/dev/api/ + cp -r docs/manual-wiki _wikidoc/docs/dev/manual + git -C $(DOCDIR) add --all + git -C $(DOCDIR) commit -a -m "wikidoc updates" + git -C $(DOCDIR) push origin wikidoc + diff --git a/docs/Makefile b/docs/Makefile index 59b9e76b6..08cfe3950 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -6,10 +6,9 @@ PKGS=\ -package ppx_tools_versioned INCS=\ - -I ${BLD}/lib/.*.objs \ - -I ${BLD}/implem/.*.objs \ - -I ${BLD}/tools/.*.objs \ - -I ${BLD}/tools/.*.objs + -I ${BLD}/lib/.*.objs/byte \ + -I ${BLD}/implem/.*.objs/byte \ + -I ${BLD}/tools/.*.objs/byte MLIS=\ $(wildcard ${SRC}/lib/*.mli) \ @@ -35,5 +34,5 @@ api/wiki/index.wiki: ${MLIS} indexdoc -i $(shell ocamlfind query wikidoc) -g odoc_wiki.cma \ ${MLIS} -clear: - rm -rf api +clean: + rm -rf html api diff --git a/docs/RELEASE.md b/docs/RELEASE.md index b93ee0934..4ac40be44 100644 --- a/docs/RELEASE.md +++ b/docs/RELEASE.md @@ -1,8 +1,21 @@ +# How to update the dev documentation + +- install wikidoc with +``` +opam pin add https://github.com/ocsigen/wikidoc.git +``` +- Run `make wikidoc` + +For more detail about wikidoc, see [how](https://github.com/ocsigen/html_of_wiki) + # How to make a release. - Update the [changelog][CHANGES.md] - Ensure the doc builds (`make -C docs`) -- Run `dune-release` -- In [ocsigen.org-data](https://github.com/ocsigen/ocsigen.org-data) - - Run the instructions from [how](https://github.com/ocsigen/html_of_wiki) - - copy `tyxml/dev` to the new version number. +- Make sure the dev doc is up-to-date (see above) +- In the wikidoc branch, copy dev to VERSION +- dune-release tag $VERSION +- dune-release distrib -n tyxml +- dune-release publish distrib +- dune-release opam pkg +- dune-release opam submit