Prettier doc

doc/index.rst

@@ -1,14 +1,9 @@
-.. DSZI_Survival documentation master file, created by
+Dokumentacja projektu DSZI_Survival
-sphinx-quickstart on Thu May 14 13:16:10 2020.
-You can adapt this file completely to your liking, but it should at least
-contain the root `toctree` directive.
-
-Welcome to DSZI_Survival's documentation!
 =========================================
 
 .. toctree::
    :maxdepth: 2
-   :caption: Contents:
+   :caption: Moduły:
 
    src/game
    src/entities

doc/src/ai.rst

@@ -1,5 +1,8 @@
-AI
+AI module
-==
+=========
+
+A* algorhithm
+*************
 
 .. automodule:: AutomaticMovement
     :members:

doc/src/entities.rst

@@ -1,32 +1,63 @@
 Entities
 ========
 
+Entity
+******
+
+Klasa bazowa wszystkich dynamicznych obiektów w projekcie.
+
 .. automodule:: Entity
     :members:
     :undoc-members:
 
+Player
+******
+
+Klasa reprezentująca gracza.
+
 .. automodule:: Player
     :members:
     :undoc-members:
     :show-inheritance:
 
+Interactable
+************
+
+Reprezentuje wszystkie obiekty, z którymi możliwa jest interakcja.
+
 .. automodule:: Interactable
     :members:
     :undoc-members:
     :show-inheritance:
 
+Pickupable
+**********
+
+Te obiekty znikają po interakcji.
 
 .. automodule:: Pickupable
     :members:
     :show-inheritance:
     :undoc-members:
 
+Pomocnicze klasy
+****************
+
+Statistics
+##########
+
+Obiekt reprezentujący statystyki.
 
 .. automodule:: Statistics
     :members:
     :undoc-members:
     :show-inheritance:
 
+Enums
+#####
+
+Moduł zawierający przydatne enumeracje.
+
 .. automodule:: Enums
     :undoc-members:
     :members:

doc/src/game.rst

@@ -1,26 +1,59 @@
 Game
 ====
 
+Moduł przechowujący główne funkcjonalności i mechanikę.
+
+Game
+####
+
+Klasa-skrypt reprezentująca obiekt gry. Zawiera główną pętle wykonawczą.
+
 .. automodule:: Game
     :members:
     :undoc-members:
 
+Screen
+######
+
+Reprezentuje wszystko co znajduje się na ekranie.
+
 .. automodule:: Screen
     :members:
     :undoc-members:
 
+EventManager
+############
+
+Obsługuje eventy.
+
 .. automodule:: EventManager
     :members:
     :undoc-members:
 
+Map
+###
+
+Reprezentuję mapę, będącą kwadratową kratownicą. Zawiera informacje o wszystkich
+entities, udostępnia metodę sprawdzające kolizje.
+
 .. automodule:: Map
     :members:
     :undoc-members:
 
+TerrainTile
+###########
+
+Reprezentuje kratkę terenu.
+
 .. automodule:: TerrainTile
     :members:
     :undoc-members:
 
+Timer
+#####
+
+Klasa odpowiadająca za śledzenie i formatowanie czasu w grze.
+
 .. automodule:: Timer
     :members:
     :undoc-members:

doc/src/ui.rst

@@ -1,40 +1,66 @@
 UI
 ==
 
+Ui
+**
+
+Kontener przechowujący wszystkie elementy interfejsu.
+
 .. automodule:: Ui
     :members:
     :undoc-members:
 
+UiBar
+*****
+
 .. automodule:: UiBar
     :show-inheritance:
     :members:
     :undoc-members:
 
+UiButton
+********
+
 .. automodule:: UiButton
     :show-inheritance:
     :members:
     :undoc-members:
 
+UiConsole
+*********
+
 .. automodule:: UiConsole
     :show-inheritance:
     :members:
     :undoc-members:
 
+UiElement
+*********
+
 .. automodule:: UiElement
     :show-inheritance:
     :members:
     :undoc-members:
 
+UiImage
+*******
+
 .. automodule:: UiImage
     :show-inheritance:
     :members:
     :undoc-members:
 
+UiText
+******
+
 .. automodule:: UiText
     :show-inheritance:
     :members:
     :undoc-members:
 
+UiWindow
+********
+
 .. automodule:: UiWindow
     :show-inheritance:
     :members: