Skip to content

Commit 6e6cdd8

Browse files
shivaahir158ravikiranchollangi
shivaahir158
and
ravikiranchollangi
authored
readthedocs for RPE (#240)
* readthedocs * requirements.txt * fixing the location of requirements.txt * adding some beginner content for the RPE doc * Update index.rst * Update index.rst --------- Co-authored-by: Ravikiran Chollangi <[email protected]>
1 parent 3aa9e36 commit 6e6cdd8

9 files changed

+169
-0
lines changed

‎.readthedocs.yml

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# .readthedocs.yml
2+
# Read the Docs configuration file
3+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
4+
5+
# Required configuration file version
6+
version: 2
7+
8+
# Specify docker image for building the doc
9+
build:
10+
os: ubuntu-22.04
11+
tools:
12+
python: "3.11"
13+
14+
# Build documentation in the docs/ directory with Sphinx
15+
sphinx:
16+
builder: dirhtml
17+
configuration: docs/source/conf.py
18+
19+
# Optionally build your docs in additional formats such as PDF and ePub
20+
formats: all
21+
22+
# Optionally set the version of Python and requirements required to build your docs
23+
python:
24+
install:
25+
- requirements: requirements.txt

‎docs/Makefile

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Minimal makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line, and also
5+
# from the environment for the first two.
6+
SPHINXOPTS ?=
7+
SPHINXBUILD ?= sphinx-build
8+
SOURCEDIR = source
9+
BUILDDIR = build
10+
11+
# Put it first so that "make" without argument is like "make help".
12+
help:
13+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14+
15+
.PHONY: help Makefile
16+
17+
# Catch-all target: route all unknown targets to Sphinx using the new
18+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19+
%: Makefile
20+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

‎docs/make.bat

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
@ECHO OFF
2+
3+
pushd %~dp0
4+
5+
REM Command file for Sphinx documentation
6+
7+
if "%SPHINXBUILD%" == "" (
8+
set SPHINXBUILD=sphinx-build
9+
)
10+
set SOURCEDIR=source
11+
set BUILDDIR=build
12+
13+
%SPHINXBUILD% >NUL 2>NUL
14+
if errorlevel 9009 (
15+
echo.
16+
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
17+
echo.installed, then set the SPHINXBUILD environment variable to point
18+
echo.to the full path of the 'sphinx-build' executable. Alternatively you
19+
echo.may add the Sphinx directory to PATH.
20+
echo.
21+
echo.If you don't have Sphinx installed, grab it from
22+
echo.https://www.sphinx-doc.org/
23+
exit /b 1
24+
)
25+
26+
if "%1" == "" goto help
27+
28+
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
29+
goto end
30+
31+
:help
32+
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
33+
34+
:end
35+
popd

‎docs/source/api_inference.rst

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
API Reference
2+
=============
3+
4+
This section will document the API reference for Rapid Power Estimator.

‎docs/source/conf.py

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Configuration file for the Sphinx documentation builder.
2+
#
3+
# For the full list of built-in configuration values, see the documentation:
4+
# https://www.sphinx-doc.org/en/master/usage/configuration.html
5+
6+
# -- Project information -----------------------------------------------------
7+
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
8+
9+
project = 'Rapid Power Estimator'
10+
copyright = '2024, Ravikiran Chollangi, Chern Yee, Volodymyr Kochyn, Nadeem Yaseen, Shiva Ahir'
11+
author = 'Ravikiran Chollangi, Chern Yee, Volodymyr Kochyn, Nadeem Yaseen, Shiva Ahir'
12+
release = '0.0.0'
13+
14+
# -- General configuration ---------------------------------------------------
15+
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
16+
17+
extensions = []
18+
19+
templates_path = ['_templates']
20+
exclude_patterns = []
21+
22+
language = 'JavaScript, React, Python'
23+
24+
# -- Options for HTML output -------------------------------------------------
25+
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
26+
27+
html_theme = 'alabaster'
28+
html_static_path = ['_static']
29+
30+
import sphinx_rtd_theme
31+
32+
html_theme = 'sphinx_rtd_theme'
33+
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
34+
35+

‎docs/source/index.rst

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
Welcome to Rapid Power Estimator's Documentation!
2+
=================================================
3+
4+
Introduction
5+
============
6+
7+
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.
8+
9+
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.
10+
11+
GUI Design and Technology Choices
12+
=================================
13+
14+
15+
Contents
16+
========
17+
18+
.. toctree::
19+
:maxdepth: 2
20+
:caption: Contents:
21+
22+
installation
23+
usage
24+
api_reference
25+
26+
Indices and tables
27+
==================
28+
29+
* :ref:`genindex`
30+
* :ref:`modindex`
31+
* :ref:`search`

‎docs/source/installation.rst

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Installation
2+
============
3+
4+
To install Rapid Power Estimator, follow these steps:
5+
6+
.. code-block:: bash
7+
8+
pip install rapid-power-estimator

‎docs/source/usage.rst

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Usage
2+
=====
3+
4+
This section will describe how to use the Rapid Power Estimator.

‎requirements.txt

+7
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,10 @@ codecov
1010
pytest-cov
1111
coverage
1212
pytest-mock
13+
sphinx
14+
sphinx-rtd-theme
15+
sphinxcontrib-napoleon
16+
sphinxcontrib-svg2pdfconverter
17+
sphinxcontrib-youtube
18+
sphinxcontrib-bibtex
19+
m2r2

0 commit comments

Comments
 (0)