From abb42dcd4886705d6ba8af27f68ef605218ac67c Mon Sep 17 00:00:00 2001 From: Philip Paquette Date: Wed, 11 Sep 2019 12:58:45 -0400 Subject: 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 Co-authored-by: notoraptor --- diplomacy/tests/network/run_real_game.py | 28 +++++++++++++++++++--------- 1 file changed, 19 insertions(+), 9 deletions(-) (limited to 'diplomacy/tests/network/run_real_game.py') diff --git a/diplomacy/tests/network/run_real_game.py b/diplomacy/tests/network/run_real_game.py index a9800b6..e243dec 100644 --- a/diplomacy/tests/network/run_real_game.py +++ b/diplomacy/tests/network/run_real_game.py @@ -18,17 +18,27 @@ """ Run tests from diplomacy.tests.network.test_real_game to test games in a real environment. Each test run a game and checks game messages and phases against an expected game data file. Current tested gama data files are JSON files located into folder diplomacy/tests/network: - 1.json - 2.json - 3.json - Need a local diplomacy server running. You must specify this server port using parameter --port=. - To run all tests: + + - 1.json + - 2.json + - 3.json + + Need a local diplomacy server running. You must specify + this server port using parameter ``--port=``. + + To run all tests: :: + python -m diplomacy.tests.network.run_real_game --port= - To run a specific test (e.g. 2.json, or 2.json and 1.json): - python -m diplomacy.tests.network.run_real_game --cases=20 --port= - python -m diplomacy.tests.network.run_real_game --cases=15,20 --port= - For help: + + To run a specific test (e.g. 2.json, or 2.json and 1.json): :: + + python -m diplomacy.tests.network.run_real_game --cases=2 --port= + python -m diplomacy.tests.network.run_real_game --cases=1,2 --port= + + For help: :: + python -m diplomacy.tests.network.run_real_game --help + """ import argparse from tornado import gen -- cgit v1.2.3