diff --git a/.gitignore b/.gitignore index 1569fe597..0413a30fc 100644 --- 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 index 501d0c9ff..f4acc30d6 100644 --- 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 new file mode 100644 index 000000000..48ca52d69 --- /dev/null +++ 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 \ No newline at end of file diff --git a/DocGen/source/simba/codetools_completion.png b/DocGen/source/simba/codetools_completion.png new file mode 100644 index 000000000..fc3154e29 Binary files /dev/null and b/DocGen/source/simba/codetools_completion.png differ diff --git a/DocGen/source/simba/codetools_jumpto.png b/DocGen/source/simba/codetools_jumpto.png new file mode 100644 index 000000000..835838627 Binary files /dev/null and b/DocGen/source/simba/codetools_jumpto.png differ diff --git a/DocGen/source/simba/codetools_paramhint.png b/DocGen/source/simba/codetools_paramhint.png new file mode 100644 index 000000000..9a627b5a5 Binary files /dev/null and b/DocGen/source/simba/codetools_paramhint.png differ diff --git a/DocGen/source/simba/index.rst b/DocGen/source/simba/index.rst new file mode 100644 index 000000000..c660d86b6 --- /dev/null +++ b/DocGen/source/simba/index.rst @@ -0,0 +1,7 @@ +Simba +===== + +.. toctree:: + :maxdepth: 2 + + codetools.rst \ No newline at end of file diff --git a/DocGen/source/tutorials/index.rst b/DocGen/source/tutorials/index.rst index 8395b7826..0218951d1 100644 --- 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 \ No newline at end of file + Input & Finder Target.rst + + plugins/index.rst \ No newline at end of file diff --git a/DocGen/source/plugins/index.rst b/DocGen/source/tutorials/plugins/index.rst similarity index 100% rename from DocGen/source/plugins/index.rst rename to DocGen/source/tutorials/plugins/index.rst diff --git a/DocGen/source/plugins/plugin-cpp.rst b/DocGen/source/tutorials/plugins/plugin-cpp.rst similarity index 100% rename from DocGen/source/plugins/plugin-cpp.rst rename to DocGen/source/tutorials/plugins/plugin-cpp.rst diff --git a/DocGen/source/plugins/writing-plugins.rst b/DocGen/source/tutorials/plugins/writing-plugins.rst similarity index 100% rename from DocGen/source/plugins/writing-plugins.rst rename to DocGen/source/tutorials/plugins/writing-plugins.rst