Skip to content

Commit eeb9803

Browse files
committed
Docs update
1 parent ea7d1b3 commit eeb9803

File tree

139 files changed

+54
-12375
lines changed

Some content is hidden

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

139 files changed

+54
-12375
lines changed

.github/workflows/mkdocs.yml

Lines changed: 5 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -3,36 +3,14 @@ on:
33
push:
44
branches:
55
- main
6-
7-
permissions:
8-
contents: write
96
jobs:
107
deploy:
118
runs-on: ubuntu-latest
129
steps:
13-
- name: Checkout repository
14-
uses: actions/checkout@v4
15-
16-
- name: Instal pgnquant for optimize plugin
17-
run: sudo apt-get install pngquant
18-
19-
- name: Set up Python runtime
20-
uses: actions/setup-python@v4
10+
- uses: actions/checkout@v3
11+
- uses: actions/setup-python@v4
2112
with:
22-
python-version: 3.x
23-
24-
- name: Install Python dependencies
25-
run: pip install mkdocs-monorepo-plugin mkdocs-redirects mkdocs-git-authors-plugin mkdocs-git-revision-date-localized-plugin mkdocs-git-committers-plugin-2 Pillow 'mkdocs-material[imaging]'
26-
27-
- name: Set up build cache
28-
uses: actions/cache@v2
29-
with:
30-
key: ${{ github.ref }}
31-
path: .cache
32-
33-
# - name: Install Insiders build
34-
# env:
35-
# GH_TOKEN: ${{ secrets.GH_TOKEN }}
36-
# run: pip install git+https://${GH_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git
37-
13+
python-version: 3.12.0
14+
- run: pip install mkdocs-material mkdocs-monorepo-plugin setuptools
15+
- run: pip install mkdocs-with-pdf
3816
- run: mkdocs gh-deploy --force

docs/README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1 @@
1-
docs directory
2-
====================
3-
This folder should contain the files for the product documentation
1+
This folder contains the markdown files for the [RTK Product Manual](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/) that are rendered by [mkdocs](https://www.mkdocs.org/).

docs/assets/CodelessBLE.zip

-13.2 KB
Binary file not shown.
-12.2 MB
Binary file not shown.

docs/assets/arduino_examples/RGB_sunlight/RGB_sunlight.ino

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

docs/assets/arduino_examples/i2c_scanner/i2c_scanner.ino

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

docs/assets/board_files/README.md

Lines changed: 0 additions & 7 deletions
This file was deleted.
-175 KB
Binary file not shown.
-102 KB
Binary file not shown.
-111 KB
Binary file not shown.
-295 KB
Binary file not shown.
-1.3 MB
Binary file not shown.

docs/assets/board_files/schematic.pdf

-266 KB
Binary file not shown.
Binary file not shown.
Binary file not shown.
-1.89 MB
Binary file not shown.
-1.06 MB
Binary file not shown.
-868 KB
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.

0 commit comments

Comments
 (0)