docs update

Villavu · Sep 23, 2023 · bfcd61d · bfcd61d
1 parent 4153b16
commit bfcd61d
Show file tree

Hide file tree

Showing 11 changed files with 44 additions and 5 deletions.
diff --git a/.gitignore b/.gitignore
@@ -34,3 +34,4 @@ backup/
 /DocGen/build/objects.inv
 /DocGen/build/_images
 /DocGen/build/plugins
+/DocGen/build/simba
diff --git a/DocGen/source/index.rst b/DocGen/source/index.rst
@@ -5,6 +5,6 @@ Simba
 .. toctree::
    :maxdepth: 2
 
+   simba/index
    tutorials/index
    api/index
-   plugins/index
diff --git a/DocGen/source/simba/codetools.rst b/DocGen/source/simba/codetools.rst
@@ -0,0 +1,30 @@
+#########
+Codetools
+#########
+
+Codetools provides multiple tools to aid programming in Simba.
+
+.. note :: Some customization is available in Simba's settings. :code:`Settings > Code Tools` 
+
+Completion box
+--------------
+
+:code:`Control + Space` or typing :code:`.` will open the completion box, which shows all available declarations. 
+
+.. figure:: codetools_completion.png
+
+Parameter hints
+---------------
+
+:code:`Control + Shift + Space` or typing :code:`(` will open parameter hints, to show what parameters are required for the method(s).
+
+.. figure:: codetools_paramhint.png
+
+Jump to declaration
+-------------------
+
+:code:`Control + mouse click` will jump to the declaration.
+
+.. note :: If the declaration is a simba method (or a plugin) the declaration will be printed in the output. 
+
+.. figure:: codetools_jumpto.png
diff --git a/DocGen/source/simba/codetools_completion.png b/DocGen/source/simba/codetools_completion.png
diff --git a/DocGen/source/simba/codetools_jumpto.png b/DocGen/source/simba/codetools_jumpto.png
diff --git a/DocGen/source/simba/codetools_paramhint.png b/DocGen/source/simba/codetools_paramhint.png
diff --git a/DocGen/source/simba/index.rst b/DocGen/source/simba/index.rst
@@ -0,0 +1,7 @@
+Simba
+=====
+
+.. toctree::
+   :maxdepth: 2
+
+   codetools.rst
diff --git a/DocGen/source/tutorials/index.rst b/DocGen/source/tutorials/index.rst
@@ -1,9 +1,10 @@
-Simba
-=====
+Tutorials
+=========
 
 .. toctree::
-   :maxdepth: 2
 
    Color Finding.rst
    Sleep Until.rst
-   Input & Finder Target.rst
+   Input & Finder Target.rst
+
+   plugins/index.rst
diff --git a/DocGen/source/plugins/index.rst → DocGen/source/tutorials/plugins/index.rst b/DocGen/source/plugins/index.rst → DocGen/source/tutorials/plugins/index.rst
diff --git a/DocGen/source/plugins/plugin-cpp.rst → ...n/source/tutorials/plugins/plugin-cpp.rst b/DocGen/source/plugins/plugin-cpp.rst → ...n/source/tutorials/plugins/plugin-cpp.rst
diff --git a/DocGen/source/plugins/writing-plugins.rst → ...rce/tutorials/plugins/writing-plugins.rst b/DocGen/source/plugins/writing-plugins.rst → ...rce/tutorials/plugins/writing-plugins.rst