first release

sunfounder · Dec 13, 2021 · e753cf1 · e753cf1
1 parent 6a8b171
commit e753cf1
Show file tree

Hide file tree

Showing 15 changed files with 96 additions and 32 deletions.
diff --git a/docs/source/building_the_pipower.rst b/docs/source/building_the_pipower.rst
@@ -0,0 +1,42 @@
+Building the PiPower
+=======================
+
+After getting familiar with the components in the package, we start to assemble PiPower.
+
+In the next steps, there are a lot of details you need to 
+notice, especially the assembly position of the battery and 
+the clear acrylic back cover.
+
+Place the Battery
+--------------------
+
+You can place the battery according to it: anode to anode; cathode to cathode.
+
+.. image:: img/media5.png
+
+Assemble the PiPower Module
+------------------------------
+
+.. image:: img/media6.png
+
+Assemble the Raspberry Pi
+---------------------------
+
+.. image:: img/media7.png
+
+Assemble the Back Cover
+--------------------------
+
+Put the gap side of acrylic back cover under the switch of PiPower module so that you can easily power the PiPower on/off.
+
+.. image:: img/media8.png
+
+Plug the USB Cable
+---------------------
+
+.. image:: img/media9.png
+
+When the battery is about to be run out, you can charge the battery through the Micro USB port of the PiPower module.
+
+.. image:: img/media10.png
+
diff --git a/docs/source/components.rst b/docs/source/components.rst
@@ -0,0 +1,6 @@
+Component
+===========
+
+.. image:: img/media3.png
+
+.. image:: img/media4.png
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -13,17 +13,15 @@
 # import os
 # import sys
 # sys.path.insert(0, os.path.abspath('.'))
+import sphinx_rtd_theme
 
-
+html_theme = 'sphinx_rtd_theme'
 # -- Project information -----------------------------------------------------
 
-project = 'pipower'
+project = 'PiPower'
 copyright = '2021, sunfounder'
 author = 'sunfounder'
 
-# The full version, including alpha/beta/rc tags
-release = '1.0'
-
 
 # -- General configuration ---------------------------------------------------
 
@@ -36,13 +34,6 @@
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
-# The language for content autogenerated by Sphinx. Refer to documentation
-# for a list of supported languages.
-#
-# This is also used if you do content translation via gettext catalogs.
-# Usually you set "language" from the command line for these cases.
-language = 'en'
-
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
@@ -54,17 +45,17 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'alabaster'
+html_theme = 'sphinx_rtd_theme'
+html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']
-import sphinx_rtd_theme
-html_theme = 'sphinx_rtd_theme'
-html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+
 html_js_files = [
-    'https://ezblock.cc/readDocFile/topHead.js',
+    'https://ezblock.cc/readDocFile/topHead.js'
 ]
 html_css_files = [
     'https://ezblock.cc/readDocFile/topHead.css',

diff --git a/docs/source/img/media1.png b/docs/source/img/media1.png
diff --git a/docs/source/img/media10.png b/docs/source/img/media10.png
diff --git a/docs/source/img/media2.png b/docs/source/img/media2.png
diff --git a/docs/source/img/media3.png b/docs/source/img/media3.png
diff --git a/docs/source/img/media4.png b/docs/source/img/media4.png
diff --git a/docs/source/img/media5.png b/docs/source/img/media5.png
diff --git a/docs/source/img/media6.png b/docs/source/img/media6.png
diff --git a/docs/source/img/media7.png b/docs/source/img/media7.png
diff --git a/docs/source/img/media8.png b/docs/source/img/media8.png
diff --git a/docs/source/img/media9.png b/docs/source/img/media9.png
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,20 +1,22 @@
-.. pipower documentation master file, created by
-   sphinx-quickstart on Mon Dec 13 15:49:12 2021.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
+PiPower
+==========
 
-Welcome to pipower's documentation!
-===================================
-
-.. toctree::
-   :maxdepth: 2
-   :caption: Contents:
+A Power Supply Module for Raspberry Pi
+---------------------------------------
 
+.. image:: img/media1.png
 
+1. Pass through Charging
+2. Output: 5V/3A
+3. Input: 5V/0.5A-2A
+4. Power Switch
+5. Battery Indicators
+6. Dimension: 90mm x 56mm x 24mm
 
-Indices and tables
-==================
+.. toctree::
+   :maxdepth: 2
 
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+   introduction
+   components
+   building_the_pipower
+
diff --git a/docs/source/introduction.rst b/docs/source/introduction.rst
@@ -0,0 +1,23 @@
+Introduction
+===============
+
+PiPower is a power supply module for Raspberry Pi with recharging function.
+
+It can output 5V/3A power supply to meet various Raspberry Pi usage situation.
+
+It has 4 power indicators; each indicator represents 25% of the power, and is equipped with a power switch to turn on/off the power of the Raspberry Pi without plugging or unplugging the power cord.
+
+When the battery power is low, you can insert a 5V/0.5A ~ 2A Micro USB cable to charge the batteries, and the charging indicator will light up and turn off when fully charged.
+
+You need to use two 18650 flat top rechargeable batteries. 
+The larger the battery capacity, the longer you use. You can 
+choose according to your needs.
+
+.. warning::
+   1. Please purchase qualified batteries.
+
+   2. Pay attention to the poles of the battery, and DO NOT connect to the positive and negative poles inversely.
+
+   3. Do not use batteries that are damaged in appearance.
+
+.. image:: img/media2.png