chiark / gitweb /
docs: Move bundle examples into examples/ directory, etc.
authorIan Jackson <ijackson@chiark.greenend.org.uk>
Sun, 23 May 2021 15:14:04 +0000 (16:14 +0100)
committerIan Jackson <ijackson@chiark.greenend.org.uk>
Sun, 23 May 2021 15:16:17 +0000 (16:16 +0100)
Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>
Makefile
docs/bundles.rst

index 4144885f15a06adb4d6b4eac42e06d0c4fabefd0..66968e313e1f696aefa21efa5cb571c2826ad225 100644 (file)
--- 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
index 6f634b3e9db2ff61a4c35e812e8ac3e711a69a46..99a592f0f8926286202a4a500de7327ad9d9862f 100644 (file)
@@ -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 <examples/mao.game.toml>`__ Mao, or many other
+   similar card games.  Three decks, 9 jokers.
+
+ * `penultima.game.toml <examples/penultima.game.toml>`__ Manipulation
+   Rummy variants with two decks.
+
+ * `vatikan.game.toml <examples/vatikan.game.toml>`__ Manipulation
+   Rummy variants with two decks.
+
+Consult the `webserver directory listing <examples/>`__ for a complete
+list.