From 2ca18a44084d12a661f75c8740cee5f6d2286020 Mon Sep 17 00:00:00 2001 From: alonamid Date: Tue, 14 May 2019 22:44:54 -0700 Subject: [PATCH] docs --- docs/ReBAR-Basics/index.rst | 19 +++++++++++++++++++ docs/index.rst | 28 +++++++++++----------------- 2 files changed, 30 insertions(+), 17 deletions(-) create mode 100644 docs/ReBAR-Basics/index.rst diff --git a/docs/ReBAR-Basics/index.rst b/docs/ReBAR-Basics/index.rst new file mode 100644 index 00000000..af625cca --- /dev/null +++ b/docs/ReBAR-Basics/index.rst @@ -0,0 +1,19 @@ +.. _ReBAR Basics: + +ReBAR Basics +================================ + +These guides will walk you through the basics of the ReBAR framework: + +- First, we will go over the different configurations avaliable. + +- Then, we will walk through adding a custom accelerator. + +Hit next to get started! + +.. toctree:: + :maxdepth: 2 + :caption: ReBAR Basics: + + rebar-generator-mixins + Adding-An-Accelerator-Tutorial diff --git a/docs/index.rst b/docs/index.rst index 4afa90d9..74d754d6 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -8,10 +8,10 @@ Welcome to ReBAR's documentation! ReBAR is a a framework for designing and evaluating full-system hardware using agile teams. It is composed of a collection of tools and libraries designed to provide an intergration between open-source and commercial tools for the development of systems-on-chip. New to ReBAR? Jump to the :ref:`rebar-basics` page for more info. -.. toctree:: - :maxdepth: 3 - :caption: Getting Started: - :numbered: + +The documentation outline should look like this + + Getting Started: ReBAR-Basics Initial-Setup/index @@ -20,18 +20,14 @@ ReBAR is a a framework for designing and evaluating full-system hardware using a Running-Simulations-Tutorial/index Building-Chips-Tutorial/index -.. toctree:: - :maxdepth: 3 - :caption: Generators: + Generators: Generators/Rocketchip/index Generators/BOOM/index Generators/Hwacha/index -.. toctree:: - :maxdepth: 3 - :caption: Simulation: + Simulation: Simulation/Open-Source-Simulators/index Simulation/Commercial-Simulators/index @@ -39,19 +35,17 @@ ReBAR is a a framework for designing and evaluating full-system hardware using a -.. toctree:: - :maxdepth: 3 - :caption: Production: + Production: Production/VLSI-Physical-Design/index - + Software/Toolchains/index .. toctree:: :maxdepth: 3 - :caption: Software: - - Software/Toolchains/index + :caption: Getting Started: + :numbered: + ReBAR-Basics/index Indices and tables