-
Notifications
You must be signed in to change notification settings - Fork 61
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
45 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -16,3 +16,4 @@ _tests | |
*.install | ||
docs/api/ | ||
_opam | ||
_wikidoc |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |