From: Ian Jackson Date: Sun, 23 May 2021 15:14:04 +0000 (+0100) Subject: docs: Move bundle examples into examples/ directory, etc. X-Git-Tag: otter-0.6.0~4 X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=commitdiff_plain;h=8bbd7a631ef80f0205a74239c24fdb8f0f530ca1;p=otter.git docs: Move bundle examples into examples/ directory, etc. Signed-off-by: Ian Jackson --- diff --git a/Makefile b/Makefile index 4144885f..66968e31 100644 --- a/Makefile +++ b/Makefile @@ -235,7 +235,8 @@ stamp/cargo.deploy-build: $(call rsrcs,.) #---------- sphnix ---------- doc-sphinx: docs/html/index.html \ - $(foreach f, $(EXAMPLE_BUNDLES), docs/html/examples/$f.zip) + $(foreach f, $(EXAMPLE_BUNDLES), docs/html/examples/$f.zip) \ + $(addprefix docs/html/examples/, $(notdir $(wildcard specs/*.toml))) @echo 'Documentation can now be found here:' @echo ' file://$(PWD)/$<' @@ -246,6 +247,10 @@ docs/html/examples/%.zip: examples/%.zip mkdir -p docs/html/examples rm -f $@ && ln $< $@ +docs/html/examples/%.toml: specs/%.toml + mkdir -p docs/html/examples + rm -f $@ && ln $< $@ + #---------- wasm ---------- $(addprefix $(WASM_PACKED)/,$(WASM_ASSETS) $(WASM_OUTPUTS)): stamp/wasm-bindgen diff --git a/docs/bundles.rst b/docs/bundles.rst index 6f634b3e..99a592f0 100644 --- a/docs/bundles.rst +++ b/docs/bundles.rst @@ -112,6 +112,16 @@ There are two examples of bundles: shape libraries automatically massaged into Otter bundle format, and one massaged game spec. -There are also several examples of game specs: +There are also several game spec examples, such as: -xxx + * `mao.game.toml `__ Mao, or many other + similar card games. Three decks, 9 jokers. + + * `penultima.game.toml `__ Manipulation + Rummy variants with two decks. + + * `vatikan.game.toml `__ Manipulation + Rummy variants with two decks. + +Consult the `webserver directory listing `__ for a complete +list.