diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b222bbe75f499cf5c3bd1ea291f8322e679de7fa..c7b55be2e46cfcc6aab8bdbd85bb098e20b6e723 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -13,4 +13,5 @@ the [style guide](https://docs.godotengine.org/en/latest/getting_started/\scripting/gdscript/gdscript_styleguide.html) described in Godot Documentation. +When creating a class or a function, describe it in the API chapter of the documentation The API follows the same style as [Godot API](https://docs.godotengine.org/en/latest/classes/index.html) diff --git a/docs/sphinx/source/api/class-sign-symb.rst b/docs/sphinx/source/api/class-sign-symb.rst new file mode 100644 index 0000000000000000000000000000000000000000..76b935107d777d8a8b1ac6a1334dcd7dc565ec4a --- /dev/null +++ b/docs/sphinx/source/api/class-sign-symb.rst @@ -0,0 +1,11 @@ +.. _SignSymb: + +========== + SignSymb +========== + +.. warning:: + + For the moment, SignSymb is only a dummy text display that is used to test + the :ref:`WorkSpace` + diff --git a/docs/sphinx/source/api/class-work-space.rst b/docs/sphinx/source/api/class-work-space.rst new file mode 100644 index 0000000000000000000000000000000000000000..b6832da52ad8c475783741944bb7a63bdc2a1dc2 --- /dev/null +++ b/docs/sphinx/source/api/class-work-space.rst @@ -0,0 +1,30 @@ +.. _WorkSpace: + +=========== + WorkSpace +=========== + +Inherits from the Container class. + +----------------- +Brief Description +----------------- + +Container used to prompt the speech in a text-editor way. + +---------- +Properties +---------- + +.. _class_WorkSpace_prop_sep: + + * Vector2 **sep** + + The sizes in pixel of the horizontal and vertical separators between two + words. + +.. _class_WorkSpace_prop_text: + + * Array **text** + + The signs of the speech in a big "string". diff --git a/docs/sphinx/source/api/index.rst b/docs/sphinx/source/api/index.rst index 2c65c93725a33cf9d72004882cb85024515e6453..3f7d6eb088b12ac7bbb751dc40e2d6b0dddee4cd 100644 --- a/docs/sphinx/source/api/index.rst +++ b/docs/sphinx/source/api/index.rst @@ -1,3 +1,11 @@ ============== Software API ============== + +.. toctree:: + :maxdepth: 1 + :glob: + + class-* + +