4f5e2ed8cb
* [docs] Explain multiclock use and restrictions * Apply suggestions from code review Co-Authored-By: Albert Magyar <albert.magyar@gmail.com> Co-Authored-By: alonamid <alonamid@eecs.berkeley.edu> * Fix doc-induced breakages Co-authored-by: Albert Magyar <albert.magyar@gmail.com> Co-authored-by: alonamid <alonamid@eecs.berkeley.edu> |
||
|---|---|---|
| .. | ||
| Advanced-Usage | ||
| Golden-Gate | ||
| Initial-Setup | ||
| Running-Simulations-Tutorial | ||
| _static | ||
| img | ||
| tools | ||
| .gitignore | ||
| Building-a-FireSim-AFI.rst | ||
| FireSim-Basics.rst | ||
| Makefile | ||
| README.md | ||
| conf.py | ||
| index.rst | ||
| make.bat | ||
| requirements.txt | ||
README.md
Building Docs
sudo pip install -r requirements.txt
make html
Look in the _build/html directory for output. You can also run
python -m SimpleHTTPServer
To get a proper locally-hosted version.
If you want to generate a pdf version, you will additionally need:
wget http://mirror.ctan.org/systems/texlive/tlnet/install-tl-unx.tar.gz
tar -xvf install-tl-unx.tar.gz
cd install-tl*
sudo ./install-tl
Follow the prompts, add the suggested path to your .bashrc.