mirror of
https://github.com/gryf/coach.git
synced 2025-12-17 19:20:19 +01:00
2b5d1dabe6
* initial ACER commit * Code cleanup + several fixes * Q-retrace bug fix + small clean-ups * added documentation for acer * ACER benchmarks * update benchmarks table * Add nightly running of golden and trace tests. (#202) Resolves #200 * comment out nightly trace tests until values reset. * remove redundant observe ignore (#168) * ensure nightly test env containers exist. (#205) Also bump integration test timeout * wxPython removal (#207) Replacing wxPython with Python's Tkinter. Also removing the option to choose multiple files as it is unused and causes errors, and fixing the load file/directory spinner. * Create CONTRIBUTING.md (#210) * Create CONTRIBUTING.md. Resolves #188 * run nightly golden tests sequentially. (#217) Should reduce resource requirements and potential CPU contention but increases overall execution time. * tests: added new setup configuration + test args (#211) - added utils for future tests and conftest - added test args * new docs build * golden test update
Coach Documentation
Coach uses Sphinx with a Read The Docs theme for its documentation website. The website is hosted on GitHub Pages, and is automatically pulled from the repository through the built docs directory.
To build the documentation website locally, first install the following requirements:
pip install Sphinx
pip install recommonmark
pip install sphinx_rtd_theme
pip install sphinx-autobuild
pip install sphinx-argparse
Then there are two option to build:
- Build using the make file (recommended). Run from within the
docs_rawdirectory:
make html
cp source/_static/css/custom.css build/html/_static/css/
rm -rf ../docs/
mkdir ../docs
touch ../docs/.nojekyll
cp -R build/html/* ../docs/
- Build automatically after every change while editing the files:
sphinx-autobuild source build/html