Skip to content

Commit 6e84d5a

Browse files
committed
Add multi board supports
1 parent 4a81c17 commit 6e84d5a

File tree

685 files changed

+826
-678
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

685 files changed

+826
-678
lines changed

.readthedocs.yaml

Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# .readthedocs.yaml
1+
#.readthedocs.yaml
22
# Read the Docs configuration file
33
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
44

@@ -14,19 +14,29 @@ build:
1414
# nodejs: "19"
1515
# rust: "1.64"
1616
# golang: "1.19"
17-
18-
# Build documentation in the "docs/" directory with Sphinx
19-
sphinx:
20-
configuration: source/conf.py
21-
22-
# Optionally build your docs in additional formats such as PDF and ePub
23-
formats:
24-
- pdf
25-
# - epub
17+
commands:
18+
- echo "Installing requirements..."
19+
- pip install -r requirements.txt
20+
- echo "Checking Sphinx version..."
21+
- sphinx-build --version # Check if sphinx-build is available
22+
- echo "Running custom Python script before build..."
23+
- python source/custom_script.py
24+
- echo "Custom script finished"
25+
- echo "Building Sphinx documentation..."
26+
- sphinx-build -b html source/ $READTHEDOCS_OUTPUT/html
2627

2728
# Optional but recommended, declare the Python requirements required
2829
# to build your documentation
2930
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
3031
python:
31-
install:
32+
install:
3233
- requirements: requirements.txt
34+
35+
# Build documentation in the directory with Sphinx
36+
sphinx:
37+
configuration: source/conf.py
38+
39+
# Optionally build your docs in additional formats such as PDF and ePub
40+
formats:
41+
- pdf
42+
# - epub

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2024 Michael Zhang
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 5 additions & 3 deletions

requirements.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
sphinx
12
sphinx-markdown-tables==0.0.17
23
sphinx-rtd-theme==2.0.0rc2
34
recommonmark
5+
sphinx-tabs

source/Getting_Started/Getting Started with AMB82-mini.rst

Lines changed: 0 additions & 297 deletions
This file was deleted.

source/Getting_Started/index.rst

Lines changed: 0 additions & 7 deletions
This file was deleted.

source/Example_Guides/Basic/Arduino-build-in example.rst renamed to source/_common/Example_Guides/Basic/Arduino-build-in example.rst

Lines changed: 184 additions & 0 deletions

0 commit comments

Comments
 (0)