firesim/docs/index.rst

52 lines
1.2 KiB
ReStructuredText

.. FireSim documentation master file, created by
sphinx-quickstart on Thu Apr 26 23:51:51 2018.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to FireSim's documentation!
===================================
New to FireSim? Jump to the :ref:`firesim-basics` page for more info.
.. toctree::
:maxdepth: 3
:caption: Getting Started:
:numbered:
FireSim-Basics
Initial-Setup/index
Running-Simulations-Tutorial/index
Building-a-FireSim-AFI
.. 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/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
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`