This repository will hold up-to-date compiled documentation for the Tyche (TechnologY Characterization and Evaluation) software. Open Tyche.pdf to begin.
To re-generate this documentation:
- Clone this repository and tyche to your local machine.
- Install a LaTeX distribution if you don't already have one. MiKTeX works and can be installed locally.
- Open an Anaconda prompt, activate the
tycheenvironment, and change the directory to the docs subdirectory within your local tyche repository directory. - Use sphinx to generate a
.texfile in this repository directory:
sphinx-build -b latex path\to\tyche\repo path\to\tyche-docs\repo
- Change the directory to your local tyche-docs repository directory.
- Use the LaTeX distribution to generate the documentation PDF:
xelatex Tyche.tex
- Use git to commit and push the updated documentation to this repository.