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

index ff0646b2baaee075372b63ef1a9acab108fc808b..4144885f15a06adb4d6b4eac42e06d0c4fabefd0 100644 (file)
--- 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 ----------
index 6388ecba989d4119aae31666eb5c0e2dbea169f3..6f634b3e9db2ff61a4c35e812e8ac3e711a69a46 100644 (file)
@@ -105,11 +105,12 @@ Examples
 
 There are two examples of bundles:
 
- * `<test-bundle.zip>`__: A small test bundle, containing three yellow
-   objects and one game spec.
+ * `test-bundle.zip <examples/test-bundle.zip>`__: A small test
+   bundle, containing three yellow objects and one game spec.
 
- * `<big-bundle.zip>`__: The Otter builtin shape libraries automatically
-   massaged into Otter bundle format, and one massaged game spec.
+ * `big-bundle.zip <examples/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: