Create Documentation

[aturfah]

Using Sphinx (and the napoleon extension), we should make documentation for this project.

Adding to 1.6.0 because we just finished cleaning up the documentation, so this shouldn't be too bad.

[aturfah]

Sphinx Documentation: http://www.sphinx-doc.org/en/1.5/tutorial.html Sphinx Napoleon Extension: http://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html

[aturfah]

For some reason this is being funky with file directories and whatnot.

This isn't super urgent, putting off until later.

[aturfah]

We could put the "documentation" as README files in each directory.

It might be worthwhile to write a script to build this documentation, to include the functions and info from the classes.

[aturfah]

Relevant info on how such a script would work https://stackoverflow.com/questions/46972403/extract-docstring-form-a-python-file-using-grep-or-awk

[aturfah]

README content for the scripts directory

Commands/Scripts

Unit Tests

• scripts/unit_tests.ps1 <testing_subdirectory>
• Runs all the test python files from the tests/ directory
• If testing_subdirectory is provided, only runs that directory's tests. Otherwise runs all tests

Style Tests

• scripts/style_tests.ps1 <module>
• Runs pycodestyle, pydocstyle, and pylint tests
• If module is provided, runs the tests for that module. Otherwise runs the test for all modules

Data Visualization

• python visualize_results.py -m <visualization_method>
• Graphs the data in the output files generated by the simulations
• Visualization methods
  • If visualization_method is elo, graph the Elo rankings over the course of the simulation
  • If visualization_method is matchups, plot the matchup matrix heatmaps

Clearing Logs

• scipts/clear_logs.ps1
• Deletes all files from the logs directory

Fetching Usage Data

• python scripts/retrieve_data.py
• Gets the data for all tiers at all usage levels.

[aturfah]

Documentation to be generated using https://github.com/aturfah/docstring_builder/ (Shameless self-promotion)

[aturfah]

Demoting this to pending status, there are more important things to do.

[aturfah]

Documentation for scripts/ added with #147