Skip to content

Commit 954c92b

Browse files
committed
Deploy Fix 3
Found what should be the error. Missing workflow item and somehow the readme was saved there instead.
1 parent 2af52eb commit 954c92b

File tree

3 files changed

+58
-71
lines changed

3 files changed

+58
-71
lines changed

.github/README.md

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

.github/workflows/mkdocs.yml

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
name: Run mkdocs
2+
on:
3+
push:
4+
branches:
5+
- main
6+
7+
permissions:
8+
contents: write
9+
jobs:
10+
deploy:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- name: Checkout repository
14+
uses: actions/checkout@v3
15+
16+
- name: Set up Python runtime
17+
uses: actions/setup-python@v4
18+
with:
19+
python-version: 3.x
20+
21+
- name: Install Python dependencies
22+
run: pip install mkdocs-monorepo-plugin mkdocs-redirects mkdocs-with-pdf weasyprint mkdocs-git-authors-plugin mkdocs-git-revision-date-localized-plugin mkdocs-git-committers-plugin-2
23+
24+
# - name: Install Chrome
25+
# run: sudo apt install google-chrome-stable
26+
27+
# - run: pip uninstall -y beautifulsoup4
28+
# - run: pip install beautifulsoup4==4.9.3
29+
30+
- name: Set up build cache
31+
uses: actions/cache@v2
32+
with:
33+
key: ${{ github.ref }}
34+
path: .cache
35+
36+
- name: Install Insiders build
37+
env:
38+
GH_TOKEN: ${{ secrets.GH_TOKEN }}
39+
run: pip install git+https://${GH_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git
40+
- run: mkdocs gh-deploy --force

README.md

Lines changed: 18 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,37 @@
1-
SparkFun <PRODUCT NAME>
1+
SparkFun Spectral UV Sensor - AS7331 (Qwiic)
22
========================================
33

4-
[![SparkFun Part Name](URL for picture of part)](URL for product on Sparkfun.com)
4+
<table class="table table-hover table-striped table-bordered">
5+
<tr align="center">
6+
<td><a href="https://www.sparkfun.com/products/23517"><img src="https://cdn.sparkfun.com/r/600-600/assets/parts/2/3/8/0/8/23517-Spectral-UV-Sensor_Feature.jpg" alt="Standard"></a></td>
7+
<td><a href="https://www.sparkfun.com/products/23518"><img src="https://cdn.sparkfun.com/r/600-600/assets/parts/2/3/8/0/9/23518-Spectral-UV-Sensor-Mini_Feature.jpg" alt="Mini"></a></td>
8+
</tr>
9+
<tr align="center">
10+
<td><a href="https://www.sparkfun.com/products/23517">SparkFun Spectral UV Sensor - AS7331 (Qwiic)</a></td>
11+
<td><a href="https://www.sparkfun.com/products/23518">SparkFun Mini Spectral UV Sensor - AS7331 (Qwiic)</a></td>
12+
</tr>
13+
</table>
514

6-
[*SparkFun Part Name (SKU)*](URL for product on Sparkfun.com)
7-
8-
<Basic description of the part.>
15+
The SparkFun Spectral UV Sensor - AS7331 (Qwiic) features the AS7331 UV sensor from ams OSRAM<sup>&copy;</sup> and measures UV radiation on three channels: UVA (320-400nm), UVB (280-320nm), and UVC (200-280nm) with high sensitivity and accuracy. The three channels on the AS7331 each have individual photodiodes with built-in interference filters. The sensor has three operating modes: Single Measurement (CMD), Continuous Measurement (CONT), and Synchronized Measurement (SYNx) with an automatic power down sequence between measurements for low current consumption in all three modes.
916

1017
Repository Contents
1118
-------------------
1219

1320
* **/Documentation** - Data sheets, additional product information
14-
* **/Enclosure** - Enclosure files
15-
* **/Firmware** - Example code
1621
* **/Hardware** - Eagle design files (.brd, .sch)
17-
* **/Libraries** - Libraries for use with the <PRODUCT NAME>
1822
* **/Production** - Production panel files (.brd)
19-
* **/Software** - Related software for the <PRODUCT NAME>
23+
* **/docs** - Documentation files for the Spectral UV Sensor
24+
* **/overrides** - Overrides for GitHub pages content
2025

2126
Documentation
2227
--------------
23-
* **[Library](GitHub library URL)** - <LANGUAGE> library for the <PRODUCT NAME>.
24-
* **[Hookup Guide](Learn.SparkFun URL)** - Basic hookup guide for the <PRODUCT NAME>.
25-
* **[SparkFun Fritzing repo](https://github.com/sparkfun/Fritzing_Parts)** - Fritzing diagrams for SparkFun products.
26-
* **[SparkFun 3D Model repo](https://github.com/sparkfun/3D_Models)** - 3D models of SparkFun products.
27-
* **[SparkFun Graphical Datasheets](https://github.com/sparkfun/Graphical_Datasheets)** -Graphical Datasheets for various SparkFun products.
28+
* **[Library](https://github.com/sparkfun/SparkFun_AS7331_Arduino_Library)** - Arduino library for the Spectral UV Sensor - AS7331 (Qwiic).
29+
* **[Hookup Guide](https://sparkfun.github.io/SparkFun_Spectral_UV_Sensor_AS7331)** - Basic hookup guide for the Spectral UV Sensor - AS7331 (Qwiic).
2830

2931
Product Versions
3032
----------------
31-
* [Part SKU](part URL) - Basic part and short description here
32-
* [Retail part SKU](retail URL) - Retail packaging of standard description here
33-
* [Any other parts this repo covers](any other URLs) - Description of said parts
34-
35-
Version History
36-
---------------
37-
* [vExxFxxZxxHxxLxxSxx](URL for tag specific to this version) - Description
38-
* [vEyyFyyZyyHyyLyySyy](URL for tag specific to this version) - Description
33+
* [SEN-23517](https://www.sparkfun.com/products/23517) - Spectral UV Sensor - AS7331 (Qwiic)
34+
* [SEN-23518](https://www.sparkfun.com/products/23518) - Mini Spectral UV Sensor - AS7331 (Qwiic)
3935

4036
License Information
4137
-------------------
@@ -49,5 +45,3 @@ If you have any questions or concerns on licensing, please contact technical sup
4945
Distributed as-is; no warranty is given.
5046

5147
- Your friends at SparkFun.
52-
53-
_<COLLABORATION CREDIT>_

0 commit comments

Comments
 (0)