firesim/docs/index.rst

69 lines
1.9 KiB
ReStructuredText

Welcome to FireSim's documentation (version "|version|")!
===========================================================
New to FireSim? Jump to the :doc:`/FireSim-Basics` page for more info.
.. toctree::
:maxdepth: 3
:caption: Getting Started:
FireSim-Basics
Getting-Started-Guides/AWS-EC2-F1-Getting-Started/index
Getting-Started-Guides/On-Premises-FPGA-Getting-Started/Xilinx-Alveo-U200-FPGAs
Getting-Started-Guides/On-Premises-FPGA-Getting-Started/Xilinx-Alveo-U250-FPGAs
Getting-Started-Guides/On-Premises-FPGA-Getting-Started/Xilinx-Alveo-U280-FPGAs
Getting-Started-Guides/On-Premises-FPGA-Getting-Started/Xilinx-VCU118-FPGAs
Getting-Started-Guides/On-Premises-FPGA-Getting-Started/RHS-Research-Nitefury-II-FPGAs
Getting-Started-Guides/On-Premises-FPGA-Getting-Started/Xilinx-Vitis-FPGAs
.. toctree::
:maxdepth: 3
:caption: Advanced Docs:
Advanced-Usage/Manager/index
Advanced-Usage/Workloads/index
Advanced-Usage/Generating-Different-Targets.rst
Advanced-Usage/Debugging-in-Software/index
Advanced-Usage/Debugging-and-Profiling-on-FPGA/index
Advanced-Usage/Conda.rst
Advanced-Usage/Supernode.rst
Advanced-Usage/Miscellaneous-Tips.rst
Advanced-Usage/FAQs.rst
.. toctree::
:maxdepth: 3
:caption: Compiler (Golden Gate) Docs:
Golden-Gate/Overview
Golden-Gate/LI-BDN
Golden-Gate/Bridges
Golden-Gate/Bridge-Walkthrough
Golden-Gate/Triggers
Golden-Gate/Resource-Optimizations
Golden-Gate/Output-Files
.. toctree::
:maxdepth: 3
:caption: Developer Docs:
Developer-Docs/GoldenGate-and-Driver-Development
Developer-Docs/Host-Platform-Debugging
Developer-Docs/VSCode-Integration
Developer-Docs/Managing-Conda-Lock-File
Developer-Docs/Manager-Development
.. toctree::
:maxdepth: 3
:caption: Miscellaneous:
External-Tutorial-Setup
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`