Skip to content

Commit

Permalink
tooling for wikidoc.
Browse files Browse the repository at this point in the history
  • Loading branch information
Drup committed Mar 6, 2020
1 parent 80d939f commit 90ffb73
Show file tree
Hide file tree
Showing 4 changed files with 45 additions and 13 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,4 @@ _tests
*.install
docs/api/
_opam
_wikidoc
25 changes: 22 additions & 3 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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 [email protected]: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

11 changes: 5 additions & 6 deletions docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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) \
Expand All @@ -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
21 changes: 17 additions & 4 deletions docs/RELEASE.md
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 90ffb73

Please sign in to comment.