firesim/docs/index.rst

39 lines
948 B
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/index
Developing-New-Devices/index
Advanced-Usage/Supernode.rst
Advanced-Usage/Miscellaneous-Tips.rst
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`