Skip to content

Commit f22333a

Browse files
committed
doc: remove zoomin integration and add new theme
This PR removes everything Zoomin-related and applies the new theme to BM docs. Signed-off-by: Bartosz Gentkowski <bartosz.gentkowski@nordicsemi.no>
1 parent af7ef07 commit f22333a

28 files changed

Lines changed: 39 additions & 256 deletions

.github/workflows/docpublish.yml

Lines changed: 0 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -50,42 +50,6 @@ jobs:
5050
azcopy cp ncs-bm "$NCS_BM_DOC_STORAGE_URL?$NCS_DOC_SAS_MAIN" --recursive=true
5151
fi
5252
53-
- name: Upload Zoomin documentation
54-
if: >
55-
github.event.workflow_run.head_branch == 'main' &&
56-
github.event.workflow_run.head_repository.full_name == github.repository
57-
run: |
58-
# trust server
59-
mkdir -p ~/.ssh
60-
ssh-keyscan upload-v1.zoominsoftware.io >> ~/.ssh/known_hosts
61-
62-
# prepare key
63-
echo "${{ secrets.NCS_ZOOMIN_KEY }}" | base64 -d > zoomin_key
64-
chmod 600 zoomin_key
65-
66-
# upload files
67-
for file in docs/*-apis-*.zip; do
68-
sftp -v -i zoomin_key nordic@upload-v1.zoominsoftware.io <<EOF
69-
cd docs-be.nordicsemi.com/doxygen/incoming
70-
put ${file}
71-
cd ../../../nordic-be-dev.zoominsoftware.io/doxygen/incoming
72-
put ${file}
73-
quit
74-
EOF
75-
done
76-
77-
for file in docs/nrf-bm-*.zip; do
78-
if [[ "$file" != *-apis-* ]]; then
79-
sftp -v -i zoomin_key nordic@upload-v1.zoominsoftware.io <<EOF
80-
cd docs-be.nordicsemi.com/sphinx-html/incoming
81-
put ${file}
82-
cd ../../../nordic-be-dev.zoominsoftware.io/sphinx-html/incoming
83-
put ${file}
84-
quit
85-
EOF
86-
fi
87-
done
88-
8953
- name: Find Comment
9054
if: ${{ github.event.workflow_run.event == 'pull_request' }}
9155
uses: peter-evans/find-comment@3eae4d37986fb5a8592848f6a574fdf654e61f9e # v3

.github/workflows/docs.yml

Lines changed: 0 additions & 78 deletions
Original file line numberDiff line numberDiff line change
@@ -84,84 +84,6 @@ jobs:
8484
echo "publish2 main ${VERSION} ${ARCHIVE}" > "${MONITOR}"
8585
fi
8686
87-
- name: Prepare Zoomin upload
88-
if: ${{ github.event_name == 'push' }}
89-
working-directory: sdk-nrf-bm/nrf-bm
90-
run: |
91-
PUBLISH="$PWD/publish"
92-
mkdir -p "$PUBLISH"
93-
94-
# Doxygen APIs combined with Sphinx
95-
declare -a SPHINX_DOXYGEN=("nrf-bm")
96-
97-
# Doxygen APIs standalone
98-
declare -a DOXYGEN=("s115_nrf54l15" "s145_nrf54l15" "s115_nrf54lm20" "s145_nrf54lm20" "s115_nrf54ls05" "s145_nrf54ls05" "s115_nrf54lv10" "s145_nrf54lv10")
99-
100-
mkdir doc/_build/html-doxygen
101-
102-
for docset in "${SPHINX_DOXYGEN[@]}"; do
103-
OUTDIR=doc/_build/html-doxygen/$docset-apis
104-
mv doc/_build/html/$docset/doxygen/html "$OUTDIR"
105-
106-
# Populate custom.properties, tags.yml
107-
cp doc/_zoomin/$docset.apis.custom.properties "$OUTDIR/custom.properties"
108-
sed -i 's/__VERSION__/'"$VERSION"'/g' "$OUTDIR/custom.properties"
109-
110-
cp doc/_zoomin/$docset.apis.tags.yml "$OUTDIR/tags.yml"
111-
sed -i 's/__VERSION__/'"$VERSION"'/g' "$OUTDIR/tags.yml"
112-
113-
# Patch links from Sphinx to other Doxygen APIs (combined)
114-
find doc/_build/html/$docset -type f -name "*.html" -exec sed -ri "/href=\"([^\"]+)\/([a-z]+)\/doxygen\/html\/([^\"]+)\"/{s//href=\"\/bundle\/\1\/\2-apis-$VERSION\/page\/\3\"/g; :a s/__/_/g;ta; }" {} \;
115-
116-
for doxset in "${DOXYGEN[@]}"; do
117-
# Patch links from Sphinx to other Doxygen APIs (standalone)
118-
find doc/_build/html/$docset -type f -name "*.html" -exec sed -ri "/href=\"([^\"]+)\/$doxset\/html\/([^\"]+)\"/{s//href=\"\/bundle\/\1\/$doxset-apis-$VERSION\/page\/\2\"/g; :a s/__/_/g;ta; }" {} \;
119-
done
120-
121-
# Patch links from Sphinx to same docset Doxygen APIs
122-
find doc/_build/html/$docset -type f -name "*.html" -exec sed -ri "/href=\"([^\"]+)\/doxygen\/html\/([^\"]+)\"/{s//href=\"\/bundle\/$docset-apis-$VERSION\/page\/\2\"/g; :a s/__/_/g;ta; }" {} \;
123-
124-
pushd "$OUTDIR"
125-
ARCHIVE="$docset-apis-$VERSION.zip"
126-
zip -rq "$ARCHIVE" .
127-
mv "$ARCHIVE" "$PUBLISH"
128-
popd
129-
done
130-
131-
for docset in "${DOXYGEN[@]}"; do
132-
OUTDIR=doc/_build/html-doxygen/$docset-apis
133-
mv doc/_build/html/$docset/html "$OUTDIR"
134-
135-
# Populate custom.properties, tags.yml
136-
cp doc/_zoomin/$docset.apis.custom.properties "$OUTDIR/custom.properties"
137-
sed -i 's/__VERSION__/'"$VERSION"'/g' "$OUTDIR/custom.properties"
138-
139-
cp doc/_zoomin/$docset.apis.tags.yml "$OUTDIR/tags.yml"
140-
sed -i 's/__VERSION__/'"$VERSION"'/g' "$OUTDIR/tags.yml"
141-
142-
pushd "$OUTDIR"
143-
ARCHIVE="$docset-apis-$VERSION.zip"
144-
zip -rq "$ARCHIVE" .
145-
mv "$ARCHIVE" "$PUBLISH"
146-
popd
147-
done
148-
149-
# nRF Bare Metal
150-
OUTDIR=doc/_build/html
151-
152-
# Populate custom.properties, tags.yml
153-
cp doc/_zoomin/nrf-bm.custom.properties "$OUTDIR/custom.properties"
154-
sed -i 's/__VERSION__/'"$VERSION"'/g' "$OUTDIR/custom.properties"
155-
156-
cp doc/_zoomin/nrf-bm.tags.yml "$OUTDIR/tags.yml"
157-
sed -i 's/__VERSION__/'"$VERSION"'/g' "$OUTDIR/tags.yml"
158-
159-
ARCHIVE="nrf-bm-$VERSION.zip"
160-
pushd "$OUTDIR"
161-
zip -rq "$ARCHIVE" .
162-
mv "$ARCHIVE" "$PUBLISH"
163-
popd
164-
16587
- name: Find nRF Connect SDK Bare Metal Edited Documents
16688
working-directory: sdk-nrf-bm/nrf-bm
16789
run: |

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,4 @@ To initialize the workspace using the command line, do the following:
2020
west update
2121
```
2222

23-
For further details on getting started, check the installation guide in the [documentation](https://docs.nordicsemi.com/bundle/nrf-bm-latest/page/index.html).
23+
For further details on getting started, check the installation guide in the [documentation](https://nrfconnectdocs.nordicsemi.com/ncs-bm/latest/nrf-bm/index.html).

doc/_zoomin/nrf-bm.apis.custom.properties

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

doc/_zoomin/nrf-bm.apis.tags.yml

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

doc/_zoomin/nrf-bm.custom.properties

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

doc/_zoomin/nrf-bm.tags.yml

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

doc/_zoomin/s115_nrf54l15.apis.custom.properties

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

doc/_zoomin/s115_nrf54l15.apis.tags.yml

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

doc/_zoomin/s115_nrf54lm20.apis.custom.properties

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

0 commit comments

Comments
 (0)