From 1dcaf646c4fddaaf2504cda74d10221548d84735 Mon Sep 17 00:00:00 2001 From: Dan Lawrence Date: Sat, 6 Apr 2024 21:20:52 +0100 Subject: [PATCH] A few documentation improvements --- docs/source/localization.rst | 9 +++++-- docs/source/pygame_gui.core.rst | 41 +++++++++++++++++++++++++++++ docs/source/pygame_gui.elements.rst | 40 ++++++++++++++++++++++++++++ 3 files changed, 88 insertions(+), 2 deletions(-) diff --git a/docs/source/localization.rst b/docs/source/localization.rst index 996ba289..5197da33 100644 --- a/docs/source/localization.rst +++ b/docs/source/localization.rst @@ -45,18 +45,23 @@ Default supported languages Right now the list of languages support by default by Pygame GUI elements and windows is: + - Arabic - German - English - Spanish - French + - Georgian + - Hebrew - Indonesian - Italian - Japanese + - Korean + - Polish - Portuguese - Russian - - Simplified Chinese - - Polish + - Ukrainian - Vietnamese + - Simplified Chinese Though many of the translations may be imperfect as they were largely not handled by native speakers (yet). If you would like to improve an existing translation or add a new one the current default translations are diff --git a/docs/source/pygame_gui.core.rst b/docs/source/pygame_gui.core.rst index def988fe..7019b9ba 100644 --- a/docs/source/pygame_gui.core.rst +++ b/docs/source/pygame_gui.core.rst @@ -8,6 +8,7 @@ Subpackages pygame_gui.core.drawable_shapes pygame_gui.core.interfaces + pygame_gui.core.text Submodules ---------- @@ -28,6 +29,38 @@ pygame\_gui.core.colour\_parser module :no-undoc-members: :show-inheritance: +pygame\_gui.core.gui\_font\_pygame module +-------------------------------------- + +.. automodule:: pygame_gui.core.gui_font_pygame + :members: + :no-undoc-members: + :show-inheritance: + +pygame\_gui.core.layered\_gui\_group module +-------------------------------------- + +.. automodule:: pygame_gui.core.layered_gui_group + :members: + :no-undoc-members: + :show-inheritance: + +pygame\_gui.core.object\_id module +-------------------------------------- + +.. automodule:: pygame_gui.core.object_id + :members: + :no-undoc-members: + :show-inheritance: + +pygame\_gui.core.resource\_loaders module +-------------------------------------- + +.. automodule:: pygame_gui.core.resource_loaders + :members: + :no-undoc-members: + :show-inheritance: + pygame\_gui.core.surface\_cache module -------------------------------------- @@ -44,6 +77,14 @@ pygame\_gui.core.ui\_appearance\_theme module :no-undoc-members: :show-inheritance: +pygame\_gui.core.ui\_container module +--------------------------------------------- + +.. automodule:: pygame_gui.core.ui_container + :members: + :no-undoc-members: + :show-inheritance: + pygame\_gui.core.ui\_element module ----------------------------------- diff --git a/docs/source/pygame_gui.elements.rst b/docs/source/pygame_gui.elements.rst index 35d337d0..d297c102 100644 --- a/docs/source/pygame_gui.elements.rst +++ b/docs/source/pygame_gui.elements.rst @@ -4,6 +4,22 @@ pygame\_gui.elements package Submodules ---------- +pygame\_gui.elements.ui\_2d\_slider module +-------------------------------------- + +.. automodule:: pygame_gui.elements.ui_2d_slider + :members: + :no-undoc-members: + :show-inheritance: + +pygame\_gui.elements.ui\_auto\_resizing\_container module +-------------------------------------- + +.. automodule:: pygame_gui.elements.auto_resizing_container + :members: + :no-undoc-members: + :show-inheritance: + pygame\_gui.elements.ui\_button module -------------------------------------- @@ -20,6 +36,14 @@ pygame\_gui.elements.ui\_drop\_down\_menu module :no-undoc-members: :show-inheritance: +pygame\_gui.elements.ui\_horizontal\_scroll\_bar module +-------------------------------------------------- + +.. automodule:: pygame_gui.elements.ui_horizontal_scroll_bar + :members: + :no-undoc-members: + :show-inheritance: + pygame\_gui.elements.ui\_horizontal\_slider module -------------------------------------------------- @@ -68,6 +92,14 @@ pygame\_gui.elements.ui\_screen\_space\_health\_bar module :no-undoc-members: :show-inheritance: +pygame\_gui.elements.ui\_scrolling\_container module +----------------------------------------------- + +.. automodule:: pygame_gui.elements.ui_scrolling_container + :members: + :no-undoc-members: + :show-inheritance: + pygame\_gui.elements.ui\_selection\_list module ----------------------------------------------- @@ -92,6 +124,14 @@ pygame\_gui.elements.ui\_text\_box module :no-undoc-members: :show-inheritance: +pygame\_gui.elements.ui\_text\_entry\_box module +------------------------------------------------- + +.. automodule:: pygame_gui.elements.ui_text_entry_box + :members: + :no-undoc-members: + :show-inheritance: + pygame\_gui.elements.ui\_text\_entry\_line module -------------------------------------------------