299 - Docs

[drvinceknight]

I'm opening a PR as I feel like I'm getting somewhere with this and would like to have @marcharper @meatballs and (I know you're busy but tagging in case) @langner's opinion.

This achieves two main things:

• Doctests: everything (a part from stochastic stuff) is doctested. This is important, I caught a couple of things that aren't quite right in the current docs. Travis should be set up to run the doctests also. These are run from a './doctest.sh' script.
• Modularisation: There are two main parts to the docs, reference (I have basically not touched this apart from introducing doctests) and tutorials. The tutorials are hopefully a bit more streamlined and very much separated out. There are currently three types (outside of contributions) tutorials:
  • getting started: The basics
  • further topics: so far just classification and morality metrics
  • advanced: nothing yet but perhaps some neat tournaments etc... (like stuff that @marcharper has done?) could go here

There are still some things left to do (I haven't done them yet just because I'm tired and want to go to 💤):

• No tutorial for the command line tool
• A lot missing from contributions (but this can be lifted from status quo)
• The automatically generated docs for the strategies, are not in. I have no idea if this had something to do with breaking readthedocs a while back and will ease this back in at the last moment.

Let me know your thoughts. Also, if anything new comes in while this PR is still ongoing (which will no doubt be the case) please comment here just so that I know about it...

[meatballs]

I've added this branch to readthedocs, so we can see the results at http://axelrod.readthedocs.org/en/299/ (or by selecting '299' from the versions drop down at the bottom LHS).

[drvinceknight]

Looks good to me -- definitely an improvement!

👍 🎆 🎉 , will wait to see what you think @meatballs (no huge rush).

[meatballs]

We should mention here that a round robin also includes self-interactions

[drvinceknight]

That's a good point. Will do.

On 22 October 2015 at 17:35, Owen Campbell notifications@github.com wrote:

In docs/reference/glossary.rst
#372 (comment):

+A match is a consecutive number of turns. The default number of turns
+used in the tournament is 200. Here is a single match between two players over
+10 turns::
+

• p1, p2 = axl.Cooperator(), axl.Defector()

• for turn in range(10):

• ... p1.play(p2)

• p1.history, p2.history

• (['C', 'C', 'C', 'C', 'C', 'C', 'C', 'C', 'C', 'C'], ['D', 'D', 'D', 'D', 'D', 'D', 'D', 'D', 'D', 'D'])

+A round robin
+-------------
+
+A round robin is the set of all potential (order invariant) matches between
+a given collection of players.
+

We should mention here that a round robin also includes self-interactions

—
Reply to this email directly or view it on GitHub
https://github.com/Axelrod-Python/Axelrod/pull/372/files#r42772158.

Dr Vincent Knight
Cardiff School of Mathematics
Senghennydd Road,
Cardiff
CF24 4AG
(+44) 29 2087 5548

[drvinceknight]

Actually, I don't think we should, this self-interaction is only relevant to the playoff matrix but (shouldn't be) isn't relevant to an actual tournament.

[meatballs]

I'm done being picky. This is an excellent job. Chapeau!

[drvinceknight]

I'm done being picky. This is an excellent job. Chapeau!

Extremely helpful @meatballs, great finds throughout. Off to walk the puppy and will address them later.

[drvinceknight]

Made all the changes apart from round_robin (one of my outdated comments was asking about is/are variety but I'm really not bothered so just went with is).

Not too sure what's best for round_robin. I understand why you want to raise that (relevant to payoff matrix) but I think that from the point of view of the getting started guide it's perhaps easiest to leave it as that?

[drvinceknight]

Not all the images are right/correct version. Do not merge.

[drvinceknight]

Good to go.

[marcharper]

I'll let @meatballs push the button since he's clearly looked more closely.

[drvinceknight]

Just a nudge @meatballs in case this has gone unnoticed: apart from my one comment about your round robin suggestion I think this is good to go. No worries if you're busy :)

[meatballs]

sorry. this had passed me by