diff --git a/.github/workflows/deploy_website.yml b/.github/workflows/deploy_website.yml index c4cd385..907aae2 100644 --- a/.github/workflows/deploy_website.yml +++ b/.github/workflows/deploy_website.yml @@ -20,7 +20,7 @@ jobs: python-version: 3.x - name: Install dependencies - run: pip install mkdocs-material + run: pip install mkdocs-material mkdocs-autodoc mkdocstrings[java] - name: Build website run: mkdocs build diff --git a/docs/how-to-multiple-projectors.md b/docs/how-to-multiple-projectors.md index fce6b38..58d053f 100644 --- a/docs/how-to-multiple-projectors.md +++ b/docs/how-to-multiple-projectors.md @@ -1,3 +1,17 @@ # How-to: Use multiple projectors -TODO \ No newline at end of file +TODO + +``` java +myShape = createShape(BOX, 150); +mapper = new ShapeMapper(this); +mappedShape = mapper.addShape("box", myShape, 2); +``` + +``` java +for (Mapping mapping : mappedShape.getMappings()) { + mapping.beginMapping(); + shape(myShape); + mapping.endMapping(); +} +``` \ No newline at end of file diff --git a/docs/reference.md b/docs/reference.md new file mode 100644 index 0000000..bd3bbb2 --- /dev/null +++ b/docs/reference.md @@ -0,0 +1,3 @@ +# Reference + +::: spacefiller.shapemapper.ShapeMapper \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index cdec952..fcd9689 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -5,6 +5,7 @@ copyright: MIT Licence. plugins: - offline + - mkdocstrings nav: - Home: index.md