1e60e173a7
@abejgonzalez's updates to cospike docs |
||
---|---|---|
.. | ||
Advanced-Usage | ||
Developer-Docs | ||
Getting-Started-Guides | ||
Golden-Gate | ||
_static | ||
graffle-src/metasim-module-hierarchy.graffle | ||
img | ||
tools | ||
.gitignore | ||
External-Tutorial-Setup.rst | ||
FireSim-Basics.rst | ||
Makefile | ||
README.md | ||
conf.py | ||
index.rst | ||
make.bat |
README.md
Building Docs
sudo -E $CONDA_EXE install --file ./requirements.txt
make html
Look in the _build/html
directory for output. You can also run
python3 -m http.server
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 /bin/bash -l -c ./install-tl
Follow the prompts, add the suggested path to your .bashrc
.