Skip to content

Commit

Permalink
A few documentation improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
MyreMylar committed Apr 6, 2024
1 parent 857a0f9 commit 1dcaf64
Show file tree
Hide file tree
Showing 3 changed files with 88 additions and 2 deletions.
9 changes: 7 additions & 2 deletions docs/source/localization.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
41 changes: 41 additions & 0 deletions docs/source/pygame_gui.core.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ Subpackages

pygame_gui.core.drawable_shapes
pygame_gui.core.interfaces
pygame_gui.core.text

Submodules
----------
Expand All @@ -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
--------------------------------------

Expand All @@ -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
-----------------------------------

Expand Down
40 changes: 40 additions & 0 deletions docs/source/pygame_gui.elements.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
--------------------------------------

Expand All @@ -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
--------------------------------------------------

Expand Down Expand Up @@ -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
-----------------------------------------------

Expand All @@ -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
-------------------------------------------------

Expand Down

0 comments on commit 1dcaf64

Please sign in to comment.