Merge pull request #162 from arnauddupuis/arnauddupuis/issue137

Fix the Sphinx mess. Fixes #137
pygamelib · Jun 19, 2021 · 1d25c5f · 1d25c5f
2 parents 967b55b + 8bf192a
commit 1d25c5f
Show file tree

Hide file tree

Showing 59 changed files with 1,063 additions and 533 deletions.
diff --git a/Makefile b/Makefile
@@ -25,6 +25,7 @@ clean:
 	find ./ -iname '*.pyc' | xargs rm -f
 	find ./ -iname '*.pyo' | xargs rm -f
 	find ./ -iname '__pycache__' | xargs rm -rf
+	(cd docs && make clean)
 
 all: coverage doc clean pp
 

diff --git a/README.md b/README.md
@@ -8,6 +8,9 @@
 [![CircleCI](https://circleci.com/gh/arnauddupuis/pygamelib.svg?style=svg)](https://circleci.com/gh/arnauddupuis/pygamelib)
 [![codecov](https://codecov.io/gh/arnauddupuis/pygamelib/branch/master/graph/badge.svg)](https://codecov.io/gh/arnauddupuis/pygamelib)
 
+<p align="center">
+  <img src="https://raw.githubusercontent.com/arnauddupuis/pygamelib/master/images/pygamelib-logo.png">
+</p>
 
 # pygamelib
 A (not so) small library for terminal based game development.

diff --git a/docs/generated/pygamelib.base.Console.rst b/docs/generated/pygamelib.base.Console.rst
diff --git a/docs/generated/pygamelib.base.Math.rst b/docs/generated/pygamelib.base.Math.rst
diff --git a/docs/generated/pygamelib.base.PglBaseObject.rst b/docs/generated/pygamelib.base.PglBaseObject.rst
diff --git a/docs/generated/pygamelib.base.PglException.rst b/docs/generated/pygamelib.base.PglException.rst
diff --git a/docs/generated/pygamelib.base.PglInvalidLevelException.rst b/docs/generated/pygamelib.base.PglInvalidLevelException.rst
diff --git a/docs/generated/pygamelib.base.PglInvalidTypeException.rst b/docs/generated/pygamelib.base.PglInvalidTypeException.rst
diff --git a/docs/generated/pygamelib.base.PglObjectIsNotMovableException.rst b/docs/generated/pygamelib.base.PglObjectIsNotMovableException.rst
diff --git a/docs/generated/pygamelib.base.PglOutOfBoardBoundException.rst b/docs/generated/pygamelib.base.PglOutOfBoardBoundException.rst
diff --git a/docs/generated/pygamelib.base.Text.rst b/docs/generated/pygamelib.base.Text.rst
diff --git a/docs/generated/pygamelib.base.Vector2D.rst b/docs/generated/pygamelib.base.Vector2D.rst
diff --git a/docs/source/base_deprecated.rst b/docs/source/base_deprecated.rst
@@ -1,7 +1,7 @@
 .. _base_deprecated-module:
 
-base (deprecated)
-=================
+Deprecated objects
+==================
 
 These are the deprecated objects of the pygamelib.base module. They should not be used
 as they are going to be removed in future versions.

diff --git a/docs/source/board_items.rst b/docs/source/board_items.rst
@@ -3,7 +3,34 @@
 board_items
 ===========
 
+.. toctree::
+
+    pygamelib.board_items.Actionable.rst
+    pygamelib.board_items.BoardComplexItem.rst
+    pygamelib.board_items.BoardItemComplexComponent.rst
+    pygamelib.board_items.BoardItem.rst
+    pygamelib.board_items.BoardItemVoid.rst
+    pygamelib.board_items.Camera.rst
+    pygamelib.board_items.Character.rst
+    pygamelib.board_items.ComplexDoor.rst
+    pygamelib.board_items.ComplexNPC.rst
+    pygamelib.board_items.ComplexPlayer.rst
+    pygamelib.board_items.ComplexTreasure.rst
+    pygamelib.board_items.ComplexWall.rst
+    pygamelib.board_items.Door.rst
+    pygamelib.board_items.GenericActionableStructure.rst
+    pygamelib.board_items.GenericStructureComplexComponent.rst
+    pygamelib.board_items.GenericStructure.rst
+    pygamelib.board_items.Immovable.rst
+    pygamelib.board_items.Movable.rst
+    pygamelib.board_items.NPC.rst
+    pygamelib.board_items.Player.rst
+    pygamelib.board_items.Projectile.rst
+    pygamelib.board_items.TextItem.rst
+    pygamelib.board_items.Tile.rst
+    pygamelib.board_items.Treasure.rst
+    pygamelib.board_items.Wall.rst
+
+
 .. automodule:: pygamelib.board_items
-    :members:
-    :undoc-members:
-    :show-inheritance:
+    :noindex:
diff --git a/docs/source/constants.rst b/docs/source/constants.rst
@@ -3,5 +3,58 @@
 constants
 =========
 
+Accessible constants are the following:
+
+General purpose:
+
+* PYGAMELIB_VERSION
+
+Directions:
+
+* NO_DIR: This one is used when no direction can be provided by an actuator (destination reached for a PathFinder for example)
+* UP
+* DOWN
+* LEFT
+* RIGHT
+* DRUP : Diagonal right up
+* DRDOWN : Diagonal right down
+* DLUP : Diagonal Left up
+* DLDOWN : Diagonal left down
+
+Permissions:
+
+* PLAYER_AUTHORIZED
+* NPC_AUTHORIZED
+* ALL_PLAYABLE_AUTHORIZED (deprecated in 1.2.0 in favor of ALL_CHARACTERS_AUTHORIZED)
+* ALL_CHARACTERS_AUTHORIZED
+* ALL_MOVABLE_AUTHORIZED
+* NONE_AUTHORIZED
+
+UI positions:
+
+* POS_TOP
+* POS_BOTTOM
+* ORIENTATION_HORIZONTAL
+* ORIENTATION_VERTICAL
+* SCREEN_H_CENTER : when placing elements with Screen.place() automatically calculate the horizontal center (use as the column parameter).
+* SCREEN_V_CENTER : when placing elements with Screen.place() automatically calculate the vertical center (use as the row parameter).
+
+Actions states (for Actuators for example):
+
+* RUNNING
+* PAUSED
+* STOPPED
+
+Accepted input (mainly used in pygamelib.gfx.ui for input dialogs):
+* INTEGER_FILTER
+* PRINTABLE_FILTER
+
+Special constants:
+
+* NO_PLAYER : That constant is used to tell the Game object not to manage the player.
+* MODE_RT : Set the game object to Real Time mode. The game runs independently from the user input.
+* MODE_TBT : Set the game object to Turn By Turn mode. The game runs turn by turn and pause between each user input.
+
 .. automodule:: pygamelib.constants
-    :members:
+
+
diff --git a/docs/source/engine.rst b/docs/source/engine.rst
@@ -3,8 +3,12 @@
 engine
 ======
 
+.. toctree::
+
+    pygamelib.engine.Board.rst
+    pygamelib.engine.Game.rst
+    pygamelib.engine.Inventory.rst
+    pygamelib.engine.Screen.rst
+
 .. automodule:: pygamelib.engine
-    :members:
-    :inherited-members:
-    :undoc-members:
-    :show-inheritance:
+    :noindex:
diff --git a/docs/source/gfx_core.rst b/docs/source/gfx_core.rst
@@ -3,8 +3,15 @@
 core
 ====
 
+.. toctree::
+
+    pygamelib.gfx.core.Animation.rst
+    pygamelib.gfx.core.Font
+    pygamelib.gfx.core.SpriteCollection.rst
+    pygamelib.gfx.core.Sprite.rst
+    pygamelib.gfx.core.Sprixel.rst
+    pygamelib.gfx.core.Color.rst
+
+
 .. automodule:: pygamelib.gfx.core
-    :members:
-    :inherited-members:
-    :undoc-members:
-    :show-inheritance:
+    :noindex: