From 4189c0c988daa939be0e8ec979ce0ae0563c4b7d Mon Sep 17 00:00:00 2001 From: "jakob.stendahl" Date: Mon, 12 Dec 2022 14:13:40 +0100 Subject: Create docs from python code --- docs/Scripting/NeoBehaviour.md | 68 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 68 insertions(+) create mode 100644 docs/Scripting/NeoBehaviour.md (limited to 'docs/Scripting/NeoBehaviour.md') diff --git a/docs/Scripting/NeoBehaviour.md b/docs/Scripting/NeoBehaviour.md new file mode 100644 index 0000000..c10d055 --- /dev/null +++ b/docs/Scripting/NeoBehaviour.md @@ -0,0 +1,68 @@ +# Documentation for `NeoBehaviour` + +::: luxcena_neo.neo_behaviour.NeoBehaviour + handler: python + options: + show_root_heading: true + show_source: false + filters: ["!^__init__"] + + +### An example of the usage of the class +```python +from luxcena_neo import NeoBehaviour + +class Main(NeoBehaviour): + def on_start(self): + strip.setPixelColor(0, "#fafafa") +``` + +--- + +::: luxcena_neo.neo_behaviour.Variable + handler: python + options: + show_root_heading: true + show_source: false + +--- + +::: luxcena_neo.neo_behaviour.ColorVariable + handler: python + options: + show_root_heading: true + show_source: false + +--- + +::: luxcena_neo.neo_behaviour.IntegerVariable + handler: python + options: + show_root_heading: true + show_source: false + +--- + +::: luxcena_neo.neo_behaviour.FloatVariable + handler: python + options: + show_root_heading: true + show_source: false + #show_category_heading: true + #show_if_no_docstring: true + +--- + +::: luxcena_neo.neo_behaviour.BooleanVariable + handler: python + options: + show_root_heading: true + show_source: false + +--- + +::: luxcena_neo.neo_behaviour.Trigger + handler: python + options: + show_root_heading: true + show_source: false -- cgit v1.2.3