diff options
| author | Philip Paquette <pcpaquette@gmail.com> | 2019-09-11 12:58:45 -0400 |
|---|---|---|
| committer | Philip Paquette <pcpaquette@gmail.com> | 2019-09-14 18:18:53 -0400 |
| commit | abb42dcd4886705d6ba8af27f68ef605218ac67c (patch) | |
| tree | 9ae16f7a09fff539fa72e65198e284bca6ac3376 /docs/index.rst | |
| parent | a954a00d263750c279dbb2c0a9ae85707022bcd7 (diff) | |
Added ReadtheDocs documentation for the public API
- Reformatted the docstring to be compatible
- Added tests to make sure the documentation compiles properly
- Added sphinx as a pip requirement
Co-authored-by: Philip Paquette <pcpaquette@gmail.com>
Co-authored-by: notoraptor <stevenbocco@gmail.com>
Diffstat (limited to 'docs/index.rst')
| -rw-r--r-- | docs/index.rst | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..5fda49c --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,42 @@ +Welcome to Diplomacy package! +============================= + +Diplomacy is a strategic board game when you play a country (power) on a map with the goal to conquer at least half to +all the supply centers present on the map. To achieve this goal, you control power units (armies and/or fleets) that +you can use to occupy empty provinces (locations), attack provinces occupied by other powers, or support other units +occupying or attacking a position. + +This is a complex game with many rules and corner cases to take into account, and, thus, an interesting subject for +both entertainment (between humans) and studies (e.g. how to create an artificial intelligence good enough to beat +humans). This project aims to provide a complete and working Python implementation of Diplomacy game with following +features: + +- A working game engine easy to use to get familiar with game rules, test corner cases, and simulate complete parties. +- An interface to allow the game to be played online, using: + + - a Python server implementation to handle many games + - a Python client implementation to play remotely using all the power and facilities of Python + - a web front-end to play remotely using a human user-friendly interface + +- Some integration interface to play with other server/client implementations, especially: + + - a DAIDE server to play with DAIDE client bots + - a webdiplomacy API to play with `webdiplomacy <http://webdiplomacy.net/>`_ server implementation + +.. toctree:: + :maxdepth: -1 + :caption: API Documentation + + api/diplomacy.client + api/diplomacy.communication + api/diplomacy.daide + api/diplomacy.engine + api/diplomacy.integration + api/diplomacy.utils + +Indices and tables +------------------ + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` |