Documentation skeleton for release

hsahovic · Oct 31, 2019 · cc4dc89 · cc4dc89
1 parent dced47b
commit cc4dc89
Show file tree

Hide file tree

Showing 14 changed files with 235 additions and 67 deletions.
diff --git a/docs/source/battle.rst b/docs/source/battle.rst
@@ -0,0 +1,10 @@
+.. _battle:
+
+The battle object
+=================
+
+
+.. automodule:: poke_env.environment.battle
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -19,7 +19,7 @@
 
 # -- Project information -----------------------------------------------------
 
-project = "Pokemon Showdown Python environment"
+project = "Poke-env"
 copyright = "2019, Haris Sahovic"
 author = "Haris Sahovic"
 
@@ -45,9 +45,11 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = "alabaster"
+html_theme = "sphinx_rtd_theme"
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ["_static"]
+html_static_path = []
+
+master_doc = "index"
diff --git a/docs/source/cross_evaluate_random_players.rst b/docs/source/cross_evaluate_random_players.rst
@@ -0,0 +1,4 @@
+.. _cross_evaluate_random_players:
+
+Cross evaluating random players
+===============================
diff --git a/docs/source/examples.rst b/docs/source/examples.rst
@@ -0,0 +1,10 @@
+.. _examples:
+
+Examples
+========
+
+.. toctree::
+    :maxdepth: 4
+
+    cross_evaluate_random_players
+    max_damage_player
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,20 +1,68 @@
-.. Pokemon Showdown Python environment documentation master file, created by
+.. Poke-env documentation master file, created by
    sphinx-quickstart on Sat Aug 10 13:11:15 2019.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to Pokemon Showdown Python environment's documentation!
-===============================================================
+Poke-env: A python interface for training Reinforcement Learning pokemon bots
+#############################################################################
+
+This project aims at providing a Python environment for interacting in `pokemon showdown <https://pokemonshowdown.com/>`__ battles, with reinforcement learning in mind. Welcome to its documentation!
+
+Getting started
+***************
+
+Installing poke-env
+===================
+
+Installing a showdown server
+============================
+
+Creating a first agent
+======================
+
+Configuring showdown players
+****************************
+
+Users without authentication
+============================
+
+Users with authentication
+=========================
+
+This project requires python >= 3.6 and a `Pokemon Showdown <https://github.com/Zarel/Pokemon-Showdown>`__ server.
+
+Examples
+********
 
 .. toctree::
-   :maxdepth: 2
-   :caption: Contents:
+   :maxdepth: 5
+
+   examples
+
+Documentation
+*************
+
+.. toctree::
+   :maxdepth: 5
+
+   poke-env
+
+Other
+*****
+
+Acknowledgements
+================
+
+This project is a follow-up of a group project from an artifical intelligence class at `Ecole Polytechnique <https://www.polytechnique.edu/>`__.
+
+You can find the original repository `here <https://github.com/hsahovic/inf581-project>`__. It is partially inspired by the `showdown-battle-bot project <https://github.com/Synedh/showdown-battle-bot>`__. Of course, none of these would have been possible without `Pokemon Showdown <https://github.com/Zarel/Pokemon-Showdown>`__.
+
+Data
+====
 
-* :ref:`modules`
+Data files are adapted version of the :samp:`js` data files of `Pokemon Showdown <https://github.com/Zarel/Pokemon-Showdown>`__.
 
-Indices and tables
-==================
+License
+=======
 
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+This project and its documentation are released under the `MIT License <https://opensource.org/licenses/MIT>`__.
diff --git a/docs/source/max_damage_player.rst b/docs/source/max_damage_player.rst
@@ -0,0 +1,4 @@
+.. _max_damage_player:
+
+Creating a simple max damage player
+===================================
diff --git a/docs/source/modules.rst b/docs/source/modules.rst
diff --git a/docs/source/move.rst b/docs/source/move.rst
@@ -0,0 +1,9 @@
+.. _move:
+
+The move object
+===============
+
+.. automodule:: poke_env.environment.move
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/other_environment.rst b/docs/source/other_environment.rst
@@ -0,0 +1,49 @@
+.. _other_environment:
+
+Other environment objects
+=========================
+
+.. automodule:: poke_env.environment.effect
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. automodule:: poke_env.environment.field
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. automodule:: poke_env.environment.move_category
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. automodule:: poke_env.environment.pokemon_gender
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. automodule:: poke_env.environment.pokemon_type
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. automodule:: poke_env.environment.side_condition
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. automodule:: poke_env.environment.status
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. automodule:: poke_env.environment.weather
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. automodule:: poke_env.environment.z_crystal
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/player.rst b/docs/source/player.rst
@@ -0,0 +1,24 @@
+.. _player:
+
+The player object and related subclasses
+========================================
+
+.. automodule:: poke_env.player.player
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. automodule:: poke_env.player.random_player
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. automodule:: poke_env.player.trainable_player
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. automodule:: poke_env.player.player_network_interface
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/poke-env.rst b/docs/source/poke-env.rst
@@ -0,0 +1,22 @@
+.. _poke_env:
+
+Poke-env
+========
+
+.. toctree::
+    :maxdepth: 4
+
+    battle
+    move
+    other_environment
+    player
+    pokemon
+    top_level_modules
+
+Module contents
+---------------
+
+.. automodule:: poke_env
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/pokemon.rst b/docs/source/pokemon.rst
@@ -0,0 +1,10 @@
+.. _pokemon:
+
+The pokemon object
+==================
+
+
+.. automodule:: poke_env.environment.pokemon
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/pokemon_showdown_env.rst b/docs/source/pokemon_showdown_env.rst
diff --git a/docs/source/top_level_modules.rst b/docs/source/top_level_modules.rst
@@ -0,0 +1,29 @@
+.. _top_level_modules:
+
+Top level modules
+=================
+
+.. automodule:: poke_env.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. automodule:: poke_env.player_configuration
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. automodule:: poke_env.server_configuration
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. automodule:: poke_env.data
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. automodule:: poke_env.exceptions
+   :members:
+   :undoc-members:
+   :show-inheritance: