Updated main index.rst as well as created nested User Guide table of content with necessary subsections (#256)

MustafaAbdaal · web-flow · commit 7869ae6d50ff · 2024-11-01T07:55:42.000-07:00
diff --git a/docs/source/api_reference.rst b/docs/source/api_reference.rst
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,30 +1,31 @@
+=================================================
 Welcome to Rapid Power Estimator's Documentation!
 =================================================
 
-Introduction
-============
+Overview
+###########
 
 Power and thermal specifications are critical considerations in the early stages of designing SoCs and FPGAs. Determining accurate power requirements and cooling solutions is essential to avoid over-designing or under-designing your product's power and thermal systems. It is a valuable tool in this process.
 
 RPE allows you to estimate power consumption at various stages of your design cycle. It simplifies the input of design information through intuitive wizards and delivers comprehensive power and thermal data analysis.
 
-GUI Design and Technology Choices
-=================================
-
 
 Contents
-========
+#########
 
 .. toctree::
    :maxdepth: 2
-   :caption: Contents:
+
+   user_guide/index
+
+.. toctree::
+   :maxdepth: 1
 
    installation
-   usage
    api_reference
 
-Indices and tables
-==================
+Indices and Tables
+###################
 
 * :ref:`genindex`
 * :ref:`modindex`
diff --git a/docs/source/usage.rst b/docs/source/usage.rst
diff --git a/docs/source/user_guide/FPGA.rst b/docs/source/user_guide/FPGA.rst
@@ -0,0 +1,20 @@
+=============
+FPGA Input
+=============
+
+This section will document FPGA input for Rapid Power Estimator.
+
+Clocking
+#########
+
+FLE - Functional Logic Element 
+###############################
+
+BRAM - Block Randon Access Memory 
+##################################
+
+DSP - Digital Signal Processor
+###############################
+
+IO - Input/Output
+##################
diff --git a/docs/source/user_guide/SoC.rst b/docs/source/user_guide/SoC.rst
@@ -0,0 +1,17 @@
+=============
+SoC Input
+=============
+
+This section will document SoC input for Rapid Power Estimator.
+
+BCPU - Boot Central Processing Unit
+#######################################
+
+ACPU - Application Central Processing Unit
+###########################################
+
+DMA - Direct Memory Access
+###########################
+
+Connectivity
+############
diff --git a/docs/source/user_guide/index.rst b/docs/source/user_guide/index.rst
@@ -0,0 +1,16 @@
+==========
+User Guide
+==========
+
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Table of Contents
+
+   introduction
+   setup
+   FPGA 
+   SoC
+   peripherals
+   memory
+   results
diff --git a/docs/source/user_guide/introduction.rst b/docs/source/user_guide/introduction.rst
@@ -0,0 +1,6 @@
+====================
+Introduction to RPE
+====================
+
+This section will document the Introduction of Rapid Power Estimator.
+
diff --git a/docs/source/user_guide/launch.rst b/docs/source/user_guide/launch.rst
@@ -0,0 +1,4 @@
+Launching Rapid Power Estimator
+=============
+
+This section will document launching of Rapid Power Estimator.
diff --git a/docs/source/user_guide/memory.rst b/docs/source/user_guide/memory.rst
@@ -0,0 +1,4 @@
+Memory Usage
+=============
+
+This section will document memory on Rapid Power Estimator.
diff --git a/docs/source/user_guide/peripherals.rst b/docs/source/user_guide/peripherals.rst
@@ -0,0 +1,5 @@
+================
+Peripheral Usage
+================
+
+This section will document peripherals on Rapid Power Estimator.
diff --git a/docs/source/user_guide/results.rst b/docs/source/user_guide/results.rst
@@ -0,0 +1,14 @@
+====================
+Analyzing Results
+====================
+
+This section will document the results on Rapid Power Estimator.
+
+FPGA Complex & Core Power
+#########################
+
+Processing Complex (SoC) Power
+##############################
+
+Overall Typical & Worst Case Power 
+##################################
diff --git a/docs/source/user_guide/setup.rst b/docs/source/user_guide/setup.rst
@@ -0,0 +1,11 @@
+=======================
+Setting up .RPE Project
+=======================
+
+This section will document how to setup a project on Rapid Power Estimator.
+
+Project Creation
+#################
+
+Device Selection
+#################
