add:基础文档

OpenSiFli · Jan 20, 2025 · 35d0f1d · 35d0f1d
1 parent 8f563ad
commit 35d0f1d
Show file tree

Hide file tree

Showing 355 changed files with 20,684 additions and 1 deletion.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -0,0 +1,65 @@
+# This is a basic workflow to help you get started with Actions
+
+name: bulid
+
+# Controls when the workflow will run
+on:
+  # main和beta分支有push或者pull request事件时触发
+  push:
+    branches: [ "main" ,"beta"]
+  pull_request:
+    branches: [ "main" ,"beta"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  # This workflow contains a single job called "build"
+  build:
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+      - uses: actions/checkout@v4
+
+      # Runs a single command using the runners shell
+      - name: publish
+        env:
+            BUILD_CONFIG: ${{ secrets.BUILD_CONFIG }}
+        run: |
+          echo "安装依赖"
+          sudo apt update
+          sudo pip3 install setuptools
+          sudo pip3 install -r requirements.txt
+          echo "开始生成静态网页"
+          sphinx-build -b html ./source ./build -E
+          echo "生成静态网页完成"
+          echo "打包build文件夹"
+          tar -zcvf build.tar.gz build
+          echo "打包完成"
+          echo "发布到服务器"
+          chmod +x ./tools/mc
+          export PATH=$PATH:$HOME/work/SiFli-Wiki/SiFli-Wiki/tools
+          mc alias set myminio $BUILD_CONFIG
+          mc cp  ./build.tar.gz myminio/web/${GITHUB_REF##*/}.tar.gz
+          echo "发布完成"
+
+
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: build
+          path: build.tar.gz   
+
+      - name: Webhook
+        run: |
+          echo "发送webhook"
+          curl -X POST -H "Content-Type: application/json" -d '{"event": "action", "action": "build", "branch": "${{ github.ref }}"}' ${{ secrets.WEBHOOK_URL }}
+          echo "发送webhook完成"
+      
+
+
+
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,8 @@
+# 所有文件夹内的 src和project文件夹
+
+src/
+project/
+
+#build文件夹
+build/
+wiki/
diff --git a/README.md b/README.md
@@ -1 +1,3 @@
-# SiFli-Wiki
+# SiFli-Wiki
+
+芯片SDK开发文档
diff --git a/requirements.txt b/requirements.txt
@@ -0,0 +1,8 @@
+Sphinx==8.1.2
+minio==7.2.14
+sphinx_design==0.6.1
+myst_parser==4.0.0
+shibuya==2024.12.21
+sphinx_copybutton==0.5.2
+
+
diff --git a/source/_static/custom.css b/source/_static/custom.css
@@ -0,0 +1,7 @@
+html[data-accent-color='blue'] {
+    --accent-9: #26bae8;
+}
+
+html.light {
+    --sy-c-link:var(--accent-9)
+}
diff --git a/source/_static/logo_favicon.png b/source/_static/logo_favicon.png
diff --git a/source/_static/logo_white.png b/source/_static/logo_white.png
diff --git a/source/_static/partials/nav-socials.html b/source/_static/partials/nav-socials.html
@@ -0,0 +1,6 @@
+<div class="sy-head-socials">
+    {%- include "components/nav-socials.html" -%}
+    <a href="https://space.bilibili.com/351087246" aria-label="Your Social network">
+      <svg t="1734674401919" class="icon" viewBox="0 0 1071 1024" version="1.1" xmlns="http://www.w3.org/2000/svg" p-id="1475" width="200" height="200"><path d="M887.365188 952.783894H184.455499C82.758914 952.783894 0 876.72402 0 783.272408V336.111466c0-93.477378 82.758914-169.537251 184.455499-169.537252h704.043373c51.969094 0 101.67082 20.225949 136.377002 55.498973A159.256801 159.256801 0 0 1 1071.846453 336.420652V783.272408c0 93.451613-82.758914 169.511486-184.481265 169.511486zM184.455499 251.600495c-54.829069 0-99.429218 37.901109-99.429218 84.510971V783.272408c0 46.609861 44.600149 84.51097 99.429218 84.51097H887.365188c54.829069 0 99.429218-37.901109 99.429218-84.51097V335.415796a74.539706 74.539706 0 0 0-22.570613-53.72115c-18.808844-19.11803-46.377972-30.09415-75.750687-30.094151z" p-id="1476"></path><path d="M397.794168 495.316736L219.651226 535.923226a36.355177 36.355177 0 0 1-15.175903-71.112889l178.142942-40.55496a35.8141 35.8141 0 0 1 43.131513 27.955611c4.302845 19.169562-8.786049 38.854434-27.95561 43.157279zM674.052285 495.316736c-19.169562-4.302845-32.258456-23.987717-27.955611-43.157279a35.8141 35.8141 0 0 1 43.131514-27.955611l178.142941 40.55496a36.355177 36.355177 0 0 1-15.175902 71.112889l-178.142942-40.554959zM268.811876 1023.999845a56.684187 56.684187 0 0 1-56.684187-56.813015v-42.590437a56.684187 56.684187 0 1 1 113.600264 0v42.590437a56.684187 56.684187 0 0 1-56.684187 56.813015zM803.034577 1023.999845a56.684187 56.684187 0 0 1-56.813015-56.813015v-42.590437a56.684187 56.684187 0 1 1 113.600264 0v42.590437a56.684187 56.684187 0 0 1-56.684187 56.813015z" p-id="1477"></path><path d="M248.918821 42.946487m26.538343-29.671097l0 0q26.538343-29.671097 56.20944-3.132755l185.900469 166.272595q29.671097 26.538343 3.132754 56.20944l0 0q-26.538343 29.671097-56.20944 3.132755l-185.900468-166.272595q-29.671097-26.538343-3.132755-56.20944Z" p-id="1478"></path><path d="M577.629382 262.330313m-26.538343-29.671098l0 0q-26.538343-29.671097 3.132755-56.20944l185.900468-166.272595q29.671097-26.538343 56.209441 3.132755l0 0q26.538343 29.671097-3.132755 56.20944l-185.900468 166.272595q-29.671097 26.538343-56.209441-3.132755Z" p-id="1479"></path><path d="M595.621982 756.373184a39.447041 39.447041 0 0 1-30.738289-14.686357L533.346672 702.677799l-32.438814 38.467951a39.730462 39.730462 0 0 1-55.473207 5.153108l-44.316729-36.535535a23.188986 23.188986 0 1 1 29.501543-35.762569l39.163621 32.258455 33.495202-39.601634a39.6274 39.6274 0 0 1 61.038563 0.566842l32.722236 40.323069 45.424646-33.933215A23.188986 23.188986 0 1 1 669.904033 710.665117l-50.655051 37.798047a39.369745 39.369745 0 0 1-23.627 7.91002z" p-id="1480"></path></svg>
+    </a>
+  </div>
diff --git a/source/about/index.md b/source/about/index.md
@@ -0,0 +1,10 @@
+# 关于思澈
+
+## 1. 企业简介
+
+
+## 2. 企业文化
+
+
+## 3. 企业荣誉
+
diff --git a/source/api/index.md b/source/api/index.md
@@ -0,0 +1,3 @@
+# API接口
+
+快速上手 get-s
diff --git a/source/board/assets/52KIT-LCD-B-Notes.png b/source/board/assets/52KIT-LCD-B-Notes.png
diff --git a/source/board/assets/52KIT-LCD-T-Notes.png b/source/board/assets/52KIT-LCD-T-Notes.png
diff --git a/source/board/assets/52Kit-22p-FPC-pin-define.png b/source/board/assets/52Kit-22p-FPC-pin-define.png
diff --git a/source/board/assets/52Kit-2x20p-pin-define.png b/source/board/assets/52Kit-2x20p-pin-define.png
diff --git a/source/board/assets/52Kit-LED-driver.png b/source/board/assets/52Kit-LED-driver.png
diff --git a/source/board/assets/SF32LB52x-DevKit-LCD_Front_Look.png b/source/board/assets/SF32LB52x-DevKit-LCD_Front_Look.png
diff --git a/source/board/assets/SF32LB52x_DevKit-40p-define.png b/source/board/assets/SF32LB52x_DevKit-40p-define.png
diff --git a/source/board/assets/SF32LB52x_DevKit-LCD_Back_Look.png b/source/board/assets/SF32LB52x_DevKit-LCD_Back_Look.png
diff --git a/source/board/assets/SF32LB52x_DevKit-LCD_Block_Diagram.png b/source/board/assets/SF32LB52x_DevKit-LCD_Block_Diagram.png
diff --git a/source/board/assets/sf32lb52X-B-watch-app-diagram.png b/source/board/assets/sf32lb52X-B-watch-app-diagram.png