firesim/docs
abejgonzalez 8339459c63 Small docs update on testing 2023-09-03 15:26:51 -07:00
..
Advanced-Usage Fix manager + update docs 2023-08-30 17:54:34 -07:00
Developer-Docs Small docs update on testing 2023-09-03 15:26:51 -07:00
Getting-Started-Guides Merge branch 'main' into garnet-2023-bump 2023-08-25 14:10:18 -07:00
Golden-Gate Merge pull request #1500 from firesim/renameserial 2023-05-10 11:37:26 -07:00
_static add a logo 2020-02-10 04:14:50 +00:00
graffle-src/metasim-module-hierarchy.graffle Update MIDAS-level -> metasimulation naming in docs (#822) 2021-08-23 17:30:56 -04:00
img Update documentation 2022-06-18 08:13:22 +00:00
tools pdfs to images script 2018-05-19 19:09:37 +00:00
.gitignore Port to Python3 + Switch to GH-A CI (#878) 2022-01-20 11:03:37 -08:00
External-Tutorial-Setup.rst rename sourceme-f1-manager.sh to sourceme-manager.sh 2023-06-05 13:59:35 -07:00
FireSim-Basics.rst Add docs for U200 2023-07-26 10:54:26 -07:00
Makefile Fix more docs 2023-05-07 00:17:56 -07:00
README.md bump docs requirements.txt to latest 2022-04-04 21:31:30 +00:00
conf.py fix pdf 2023-06-30 10:22:41 +00:00
index.rst Add docs for U200 2023-07-26 10:54:26 -07:00
make.bat New squashed FireSim repo for open-sourcing 2018-05-13 19:40:34 +00:00

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.