itsscb/esp-hal
1
0
Fork 0
mirror of https://github.com/esp-rs/esp-hal.git synced 2025-09-28 04:40:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Tweak the documentation URL slightly (#1250)

Browse Source 
* Tweak the documentation URL slightly

* Ignore locally generated docs
This commit is contained in:
Jesse Braham 2024-03-07 17:19:07 +00:00 committed by GitHub
parent 518e995b2c
commit 4bcd5cf611
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.github/scripts/build_docs.sh vendored
View File

@ -14,7 +14,7 @@ CHIPS=("esp32" "esp32c2" "esp32c3" "esp32c6" "esp32h2" "esp32p4" "esp32s2" "esp3
for CHIP in "${CHIPS[@]}"; do for CHIP in "${CHIPS[@]}"; do
cargo xtask build-documentation \ cargo xtask build-documentation \
--output-path="docs/$PKG_VERSION"/"$CHIP"/ \ --output-path="docs/esp-hal/$PKG_VERSION"/"$CHIP"/ \
esp-hal \ esp-hal \
"$CHIP" "$CHIP"
done done

3
.gitignore vendored
View File

@ -19,3 +19,6 @@ wokwi.toml
# We'll ignore VS Code settings (at least for now...) # We'll ignore VS Code settings (at least for now...)
**/.vscode/settings.json **/.vscode/settings.json
# Ignore generated documentation
docs/

2
resources/.prettierrc.json
View File

@ -1,4 +1,4 @@
{ {
"printWidth": 100, "printWidth": 120,
"tabWidth": 2 "tabWidth": 2
} }

21
resources/index.html
View File

@ -7,10 +7,7 @@
<title>esp-rs docs</title> <title>esp-rs docs</title>
<link rel="icon" href="esp-rs.svg" /> <link rel="icon" href="esp-rs.svg" />
<link <link href="https://fonts.googleapis.com/css2?family=Fira+Sans:wght@400;500&display=swap" rel="stylesheet" />
href="https://fonts.googleapis.com/css2?family=Fira+Sans:wght@400;500&display=swap"
rel="stylesheet"
/>
<link <link
href="https://fonts.googleapis.com/css2?family=Source+Serif+4:ital,wght@0,400;0,600;1,400;1,600&display=swap" href="https://fonts.googleapis.com/css2?family=Source+Serif+4:ital,wght@0,400;0,600;1,400;1,600&display=swap"
rel="stylesheet" rel="stylesheet"
@ -91,49 +88,49 @@
the package version in the URL and '.crate-version' span. --> the package version in the URL and '.crate-version' span. -->
<div class="crate"> <div class="crate">
<span class="crate-name"><a href="0.15.0/esp32/esp_hal/index.html">esp32</a></span> <span class="crate-name"><a href="esp-hal/0.15.0/esp32/esp_hal/index.html">esp32</a></span>
<span class="crate-description">esp-hal (targeting ESP32)</span> <span class="crate-description">esp-hal (targeting ESP32)</span>
<span class="crate-version">0.15.0</span> <span class="crate-version">0.15.0</span>
</div> </div>
<div class="crate"> <div class="crate">
<span class="crate-name"><a href="0.15.0/esp32c2/esp_hal/index.html">esp32c2</a></span> <span class="crate-name"><a href="esp-hal/0.15.0/esp32c2/esp_hal/index.html">esp32c2</a></span>
<span class="crate-description">esp-hal (targeting ESP32-C2)</span> <span class="crate-description">esp-hal (targeting ESP32-C2)</span>
<span class="crate-version">0.15.0</span> <span class="crate-version">0.15.0</span>
</div> </div>
<div class="crate"> <div class="crate">
<span class="crate-name"><a href="0.15.0/esp32c3/esp_hal/index.html">esp32c3</a></span> <span class="crate-name"><a href="esp-hal/0.15.0/esp32c3/esp_hal/index.html">esp32c3</a></span>
<span class="crate-description">esp-hal (targeting ESP32-C3)</span> <span class="crate-description">esp-hal (targeting ESP32-C3)</span>
<span class="crate-version">0.15.0</span> <span class="crate-version">0.15.0</span>
</div> </div>
<div class="crate"> <div class="crate">
<span class="crate-name"><a href="0.15.0/esp32c6/esp_hal/index.html">esp32c6</a></span> <span class="crate-name"><a href="esp-hal/0.15.0/esp32c6/esp_hal/index.html">esp32c6</a></span>
<span class="crate-description">esp-hal (targeting ESP32-C6)</span> <span class="crate-description">esp-hal (targeting ESP32-C6)</span>
<span class="crate-version">0.15.0</span> <span class="crate-version">0.15.0</span>
</div> </div>
<div class="crate"> <div class="crate">
<span class="crate-name"><a href="0.15.0/esp32h2/esp_hal/index.html">esp32h2</a></span> <span class="crate-name"><a href="esp-hal/0.15.0/esp32h2/esp_hal/index.html">esp32h2</a></span>
<span class="crate-description">esp-hal (targeting ESP32-H2)</span> <span class="crate-description">esp-hal (targeting ESP32-H2)</span>
<span class="crate-version">0.15.0</span> <span class="crate-version">0.15.0</span>
</div> </div>
<div class="crate"> <div class="crate">
<span class="crate-name"><a href="0.15.0/esp32p4/esp_hal/index.html">esp32p4</a></span> <span class="crate-name"><a href="esp-hal/0.15.0/esp32p4/esp_hal/index.html">esp32p4</a></span>
<span class="crate-description">esp-hal (targeting ESP32-P4)</span> <span class="crate-description">esp-hal (targeting ESP32-P4)</span>
<span class="crate-version">0.15.0</span> <span class="crate-version">0.15.0</span>
</div> </div>
<div class="crate"> <div class="crate">
<span class="crate-name"><a href="0.15.0/esp32s2/esp_hal/index.html">esp32s2</a></span> <span class="crate-name"><a href="esp-hal/0.15.0/esp32s2/esp_hal/index.html">esp32s2</a></span>
<span class="crate-description">esp-hal (targeting ESP32-S2)</span> <span class="crate-description">esp-hal (targeting ESP32-S2)</span>
<span class="crate-version">0.15.0</span> <span class="crate-version">0.15.0</span>
</div> </div>
<div class="crate"> <div class="crate">
<span class="crate-name"><a href="0.15.0/esp32s3/esp_hal/index.html">esp32s3</a></span> <span class="crate-name"><a href="esp-hal/0.15.0/esp32s3/esp_hal/index.html">esp32s3</a></span>
<span class="crate-description">esp-hal (targeting ESP32-S3)</span> <span class="crate-description">esp-hal (targeting ESP32-S3)</span>
<span class="crate-version">0.15.0</span> <span class="crate-version">0.15.0</span>
</div> </div>