Skip to content

Commit 653b914

Browse files
committed
Updated each section's .rst file with subsections
Subsections were added to the following sections: Setting up .RPE Project, FPGA input, SoC input, Analyzing Results. For now subsections will not be needed on Peripheral Usage & Memory Usage sections.
1 parent e2358e7 commit 653b914

File tree

8 files changed

+66
-11
lines changed

8 files changed

+66
-11
lines changed

docs/source/index.rst

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,17 @@
1+
=================================================
12
Welcome to Rapid Power Estimator's Documentation!
23
=================================================
34

45
Overview
5-
============
6+
###########
67

78
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.
89

910
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.
1011

1112

1213
Contents
13-
========
14+
#########
1415

1516
.. toctree::
1617
:maxdepth: 2
@@ -23,8 +24,8 @@ Contents
2324
installation
2425
api_reference
2526

26-
Indices and tables
27-
==================
27+
Indices and Tables
28+
###################
2829

2930
* :ref:`genindex`
3031
* :ref:`modindex`

docs/source/user_guide/FPGA.rst

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,20 @@
1+
=============
12
FPGA Input
23
=============
34

4-
This section will document FPGA inpout for Rapid Power Estimator.
5+
This section will document FPGA input for Rapid Power Estimator.
6+
7+
Clocking
8+
#########
9+
10+
FLE - Functional Logic Element
11+
###############################
12+
13+
BRAM - Block Randon Access Memory
14+
##################################
15+
16+
DSP - Digital Signal Processor
17+
###############################
18+
19+
IO - Input/Output
20+
##################

docs/source/user_guide/SoC.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,17 @@
1+
=============
12
SoC Input
23
=============
34

45
This section will document SoC input for Rapid Power Estimator.
6+
7+
BCPU - Boot Central Processing Unit
8+
#######################################
9+
10+
ACPU - Application Central Processing Unit
11+
###########################################
12+
13+
DMA - Direct Memory Access
14+
###########################
15+
16+
Connectivity
17+
############

docs/source/user_guide/index.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
1+
==========
12
User Guide
2-
=====
3+
==========
34

45

56
.. toctree::
67
:maxdepth: 2
78
:caption: Table of Contents
89

910
introduction
10-
launch
11+
setup
1112
FPGA
1213
SoC
1314
peripherals
Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
Introduction to Rapid Power Estimator
2-
=============
1+
====================
2+
Introduction to RPE
3+
====================
34

45
This section will document the Introduction of Rapid Power Estimator.
6+
Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1+
================
12
Peripheral Usage
2-
=============
3+
================
34

45
This section will document peripherals on Rapid Power Estimator.

docs/source/user_guide/results.rst

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,14 @@
1+
====================
12
Analyzing Results
2-
=============
3+
====================
34

45
This section will document the results on Rapid Power Estimator.
6+
7+
FPGA Complex & Core Power
8+
#########################
9+
10+
Processing Complex (SoC) Power
11+
##############################
12+
13+
Overall Typical & Worst Case Power
14+
##################################

docs/source/user_guide/setup.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
=======================
2+
Setting up .RPE Project
3+
=======================
4+
5+
This section will document how to setup a project on Rapid Power Estimator.
6+
7+
Project Creation
8+
#################
9+
10+
Device Selection
11+
#################

0 commit comments

Comments
 (0)