Name		Name	Last commit message	Last commit date
parent directory ..
diagrams		diagrams
reference/api		reference/api
sections		sections
Makefile		Makefile
README.md		README.md
Trading_Agent_Competition____Specification.pdf		Trading_Agent_Competition____Specification.pdf
agent.png		agent.png
conf.py		conf.py
controller_gui.gif		controller_gui.gif
controller_gui.png		controller_gui.png
index.rst		index.rst
make.bat		make.bat
publish_to_ghpages.sh		publish_to_ghpages.sh
sandbox.png		sandbox.png
visdom_env.png		visdom_env.png

README.md

TAC Documentation

This requires pandoc to be installed locally. See here for instructions.

Before getting started, check that:
- You have followed the steps under 'Dependencies' and 'Preliminaries' on root readme.
- You have installed the development dependencies as described on root readme.
Activate the virtual environment:
```
pipenv shell
```
Enter docs:
```
cd docs
```

Run:

sphinx-apidoc -o reference/api/ ../tac/
make html

To display the documentation in your browser, open the index.html file in ./_build/html/index.html.

firefox _build/html/index.html

open _build/html/index.html

./publish_to_ghpages.sh VERSION_TAG

where VERSION_TAG is the version tag of the release.