From: Ian Jackson Date: Sun, 23 May 2021 15:08:37 +0000 (+0100) Subject: docs: Move bundle examples into examples/ directory. X-Git-Tag: otter-0.6.0~5 X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=commitdiff_plain;h=910a64cbeb34b574e42e160eb9ac3b681aace63b;p=otter.git docs: Move bundle examples into examples/ directory. Signed-off-by: Ian Jackson --- diff --git a/Makefile b/Makefile index ff0646b2..4144885f 100644 --- a/Makefile +++ b/Makefile @@ -235,14 +235,15 @@ stamp/cargo.deploy-build: $(call rsrcs,.) #---------- sphnix ---------- doc-sphinx: docs/html/index.html \ - $(foreach f, $(EXAMPLE_BUNDLES), docs/html/$f.zip) + $(foreach f, $(EXAMPLE_BUNDLES), docs/html/examples/$f.zip) @echo 'Documentation can now be found here:' @echo ' file://$(PWD)/$<' docs/html/index.html: docs/conf.py $(wildcard docs/*.md docs/*.rst docs/*.png) $(SPHINXBUILD) -M html docs docs $(SPHINXOPTS) -docs/html/%.zip: examples/%.zip +docs/html/examples/%.zip: examples/%.zip + mkdir -p docs/html/examples rm -f $@ && ln $< $@ #---------- wasm ---------- diff --git a/docs/bundles.rst b/docs/bundles.rst index 6388ecba..6f634b3e 100644 --- a/docs/bundles.rst +++ b/docs/bundles.rst @@ -105,11 +105,12 @@ Examples There are two examples of bundles: - * ``__: A small test bundle, containing three yellow - objects and one game spec. + * `test-bundle.zip `__: A small test + bundle, containing three yellow objects and one game spec. - * ``__: The Otter builtin shape libraries automatically - massaged into Otter bundle format, and one massaged game spec. + * `big-bundle.zip `__: The Otter builtin + shape libraries automatically massaged into Otter bundle format, + and one massaged game spec. There are also several examples of game specs: