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 /README.md | |
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 'README.md')
-rw-r--r-- | README.md | 6 |
1 files changed, 5 insertions, 1 deletions
@@ -1,4 +1,4 @@ -# Diplomacy: DATC-Compliant Game Engine +# Diplomacy: DATC-Compliant Game Engine [](https://travis-ci.org/diplomacy/diplomacy) [](https://docs.diplomacy.ai/en/latest/?badge=latest) This project contains an open-source DATC-compliant Diplomacy game engine, a client-server architecture for network play, a web interface to play against bots and to visualize games, and a DAIDE-compatible adapter to connect DAIDE bots to the server. @@ -6,6 +6,10 @@ This project contains an open-source DATC-compliant Diplomacy game engine, a cli <img width="500" src="docs/images/map_overview.png" alt="Diplomacy Map Overview"> </p> +## Documentation + +The complete documentation is available at [docs.diplomacy.ai](https://docs.diplomacy.ai/). + ## Getting Started ### Installation |