firesim/docs
abejgonzalez cd58cfd40b Fix documentation Vitis deploy manager 2022-12-21 12:42:04 -08:00
..
Advanced-Usage Fix documentation Vitis deploy manager 2022-12-21 12:42:04 -08:00
Developer-Docs Rewrite MIDAS tests (#1327) 2022-12-12 20:59:15 +02:00
Golden-Gate Rewrite MIDAS tests (#1327) 2022-12-12 20:59:15 +02:00
Initial-Setup Merge pull request #1206 from firesim/refactor_conda_abe 2022-09-15 18:20:13 -07:00
Running-Simulations-Tutorial docs: Remove old config-based freq specification; describe new mechanism 2022-10-30 20:01:36 -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
Building-a-FireSim-AFI.rst Remove references to buildafi; replace with buildbitstream (#1287) 2022-12-11 03:40:59 +00:00
External-Tutorial-Setup.rst docs: Remove old config-based freq specification; describe new mechanism 2022-10-30 20:01:36 -07:00
FireSim-Basics.rst Update documentation 2022-06-18 08:13:22 +00:00
Makefile Port to Python3 + Switch to GH-A CI (#878) 2022-01-20 11:03:37 -08:00
README.md bump docs requirements.txt to latest 2022-04-04 21:31:30 +00:00
conf.py Merge pull request #1206 from firesim/refactor_conda_abe 2022-09-15 18:20:13 -07:00
index.rst Address comments 2022-10-19 11:15:05 -07:00
make.bat New squashed FireSim repo for open-sourcing 2018-05-13 19:40:34 +00:00
requirements.txt Update documentation 2022-06-18 08:13:22 +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.