-
Notifications
You must be signed in to change notification settings - Fork 264
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Documentation revamp #299
Comments
We could pull in some of the stuff from my AxelrodExamples repo, like the example tournaments, with more explanation and a narrative of course. In particular, duplicating the S&P tournament (and perhaps Tyler's tournament) make sense in line with the goals of the project (IMO). Maybe under a "reproducing tournaments" section? |
If I understand you correctly I think that sits really nicely under my suggested In essence the tutorials would be plugins, interesting ones could be thrown in... |
I think that the documentation needs a lot of work. It doesn't really serve it's purpose. This is a relic of my initial poor contribution and then a process that built on that by incrementally adding to it.
The only way to understand the library is to read (and remember) the documentation from start to finish. This is because the documentation is a mix/hybrid of a tutorial and a reference document.
My suggestion is along the lines of the following:
So I would suggest the docs file structure would look something like:
This would have the advantage of people being able to write new tutorials/references when new things are included. Basically everything becomes modular.
Another important thing I think we should ensure is doctesting the docs. Then have a script that we run to run tests and finally ensure this is on travis. The main reasoning behind this is to ensure that any changes in the code are tested in the docs.
If everyone thinks this is a long the right lines I'd like to pick an initial stab up :)
The text was updated successfully, but these errors were encountered: