Skip to content

Commit 16a29b0

Browse files
patch: Create versioned docs for Python SDK
Signed-off-by: Vipul Gupta (@vipulgupta2048) <[email protected]>
1 parent e038ddb commit 16a29b0

File tree

8 files changed

+39
-5
lines changed

8 files changed

+39
-5
lines changed

.cspell/balena-words.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ balenacli
88
balenahup
99
balenalib
1010
balenasdk
11+
balenasdkpython
1112
balenista
1213
balenistas
1314
Barys

.gitignore

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ tmp
1515

1616
# Ignore external docs that are pulled via tools/fetch-external.sh
1717
# pages/reference/sdk/node-sdk.md
18-
pages/reference/sdk/python-sdk.md
18+
# pages/reference/sdk/python-sdk.md
1919

2020
pages/reference/supervisor/supervisor-api.md
2121
pages/reference/supervisor/upgrade-policy.md
@@ -50,6 +50,10 @@ shared/balena-cli-versions/
5050
config/dictionaries/balenasdk.json
5151
shared/balena-sdk-versions/
5252

53+
# Ignore dynamic Python SDK version docs
54+
config/dictionaries/balenasdkpython.json
55+
shared/balena-sdk-python-versions/
56+
5357
# Ignore dynamic assets generated for Getting Started
5458
static/img/device/**
5559
config/dictionaries/device.json

config/navigation.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ Reference
152152
CLI[/reference/balena-cli/$balenacli]
153153
SDKs
154154
Node.js SDK[/reference/sdk/node-sdk/$balenasdk]
155-
Python SDK[/reference/sdk/python-sdk]
155+
Python SDK[/reference/sdk/python-sdk/$balenasdkpython]
156156
Deprecation Policy[/reference/sdk/deprecation-policy]
157157

158158
Diagnostics

config/redirects.txt

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -196,8 +196,8 @@
196196
/tools/cli /reference/balena-cli/latest/
197197
/tools/sdk/ /reference/sdk/node-sdk/latest/
198198
/tools/sdk /reference/sdk/node-sdk/latest/
199-
/tools/python-sdk/ /reference/sdk/python-sdk/
200-
/tools/python-sdk /reference/sdk/python-sdk/
199+
/tools/python-sdk/ /reference/sdk/python-sdk/latest/
200+
/tools/python-sdk /reference/sdk/python-sdk/latest/
201201
/runtime/resin-base-images/ /reference/base-images/balena-base-images/
202202
/runtime/resin-base-images /reference/base-images/balena-base-images/
203203
/configuration/custom-docker-base-images/ /reference/base-images/customer-docker-base-images/
@@ -274,6 +274,10 @@
274274
/reference/sdk/node-sdk/ /reference/sdk/node-sdk/latest/
275275
/reference/sdk/node-sdk /reference/sdk/node-sdk/latest/
276276

277+
# Versioned Python.js SDK docs
278+
/reference/sdk/python-sdk/ /reference/sdk/python-sdk/latest/
279+
/reference/sdk/python-sdk /reference/sdk/python-sdk/latest/
280+
277281
# Important: keep dynamic redirect below the static redirects
278282
# https://developers.cloudflare.com/pages/platform/redirects/
279283

pages/reference/sdk/python-sdk.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
title: balena Python SDK Documentation
3+
4+
layout: balena-sdk-python.html
5+
6+
dynamic:
7+
variables: [ $balenasdkpython ]
8+
ref: $original_ref/$balenasdkpython
9+
$switch_text: balena SDK version $balenasdkpython
10+
---
11+
12+
# Balena Python SDK {{ $balenasdkpython.version }} Documentation
13+
14+
{{import "balena-sdk-python-versions"}}

templates/balena-sdk-python.html

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{% extends "default.html" %}
2+
3+
{% block dynamicSwitchCustom %}
4+
<p class="dynamic-switch__append">
5+
</p>
6+
{% endblock %}
7+
8+
<div id="output"></div>

tools/build.sh

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,9 @@ node ./tools/versioning.js https://github.com/balena-io/balena-cli/blob/master/d
1616
# Generate versioned balena-sdk docs
1717
node ./tools/versioning.js https://github.com/balena-io/balena-sdk/blob/master/DOCUMENTATION.md
1818

19+
# Generate versioned balena-python-sdk docs
20+
node ./tools/versioning.js https://github.com/balena-io/balena-sdk-python/blob/master/DOCUMENTATION.md
21+
1922
# Generate Masterclasses Dynamically
2023
./tools/build-masterclass.sh
2124

tools/fetch-external.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ cd shared/sdk/ && {
100100
} &
101101

102102
# get latest python SDK docs
103-
curl --fail --show-error -o pages/reference/sdk/python-sdk.md -L https://github.com/balena-io/balena-sdk-python/raw/master/DOCUMENTATION.md &
103+
# curl --fail --show-error -o pages/reference/sdk/python-sdk.md -L https://github.com/balena-io/balena-sdk-python/raw/master/DOCUMENTATION.md &
104104

105105
# get latest base images ref docs
106106
cd pages/reference/base-images/ && {

0 commit comments

Comments
 (0)