summaryrefslogtreecommitdiffstatshomepage
path: root/docs/source/plugins/layout.rst
diff options
context:
space:
mode:
author Vas Crabb <vas@vastheman.com>2021-10-24 05:48:05 +1100
committer Vas Crabb <vas@vastheman.com>2021-10-24 05:48:05 +1100
commit669b1f6adecfd940d5ae8b97150dc73db04894c5 (patch)
tree3b32a4f2d55f558be04294ebe818c8f35135ef8b /docs/source/plugins/layout.rst
parent3a11f9168703f33f2f066c3e9d0f6905f2c95453 (diff)
-docs: Started documenting plugins.
* Also added a couple of missing command-line options, and added a local table of contents to the (rather long) command line options page. -Added a separate CI target for localisation updates that produces an artefact, and removed the message catalogs from the trigger paths for the Linux CI build.
Diffstat (limited to 'docs/source/plugins/layout.rst')
-rw-r--r--docs/source/plugins/layout.rst9
1 files changed, 9 insertions, 0 deletions
diff --git a/docs/source/plugins/layout.rst b/docs/source/plugins/layout.rst
new file mode 100644
index 00000000000..5c57afccb7a
--- /dev/null
+++ b/docs/source/plugins/layout.rst
@@ -0,0 +1,9 @@
+.. _plugins-layout:
+
+Layout Plugin
+=============
+
+When enabled, the layout plugin allows embedded Lua scripts in layout files to
+run. Built-in artwork for some machines and some external artwork packages can
+use Lua scripts to provide enhanced interactive features. See :ref:`layscript`
+for an introduction to layout file scripting.