Skip to content

Commit 3c08ed7

Browse files
committed
doc: Add back new theme and remove Zoomin workflow
Add back the new theme and remove Zoomin workflow for go live. Signed-off-by: divya pillai <divya.pillai@nordicsemi.no>
1 parent a72923d commit 3c08ed7

5 files changed

Lines changed: 6 additions & 80 deletions

File tree

.github/workflows/doc-build.yml

Lines changed: 0 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,6 @@ permissions:
55

66
on:
77
workflow_dispatch:
8-
inputs:
9-
documentation_tag:
10-
type: string
11-
required: false
12-
default: "latest"
13-
description: "Label of the documentation"
14-
publish_to_prod:
15-
type: boolean
16-
default: true
17-
publish_to_dev:
18-
type: boolean
19-
default: true
208
pull_request:
219
types: [opened, synchronize, reopened]
2210
branches:
@@ -110,26 +98,6 @@ jobs:
11098
mv "${MONITOR}" "$PUBLISH"
11199
if [[ -f pr.txt ]]; then mv pr.txt "$PUBLISH"; fi
112100
113-
- name: Prepare Zoomin upload
114-
if: ${{ github.event_name == 'push' }}
115-
run: |
116-
PUBLISH="$PWD/publish"
117-
mkdir -p "$PUBLISH"
118-
119-
OUTDIR=doc/build/html
120-
ARCHIVE="addon-serial_modem_$VERSION.zip"
121-
122-
cp doc/custom.properties "$OUTDIR/custom.properties"
123-
sed -i 's/__VERSION__/'"$VERSION"'/g' "$OUTDIR/custom.properties"
124-
125-
cp doc/tags.yml "$OUTDIR/tags.yml"
126-
sed -i 's/__VERSION__/'"$VERSION"'/g' "$OUTDIR/tags.yml"
127-
128-
pushd "$OUTDIR"
129-
zip -rq "$ARCHIVE" .
130-
mv "$ARCHIVE" "$PUBLISH"
131-
popd
132-
133101
- name: Store
134102
if: ${{ !contains(github.event.pull_request.labels.*.name, 'external') || contains(github.event.pull_request.labels.*.name, 'CI-trusted-author') }}
135103
uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0

.github/workflows/doc-on-push-zoomin-publish.yml

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

.github/workflows/doc-publish.yml

Lines changed: 0 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -52,33 +52,6 @@ jobs:
5252
azcopy cp $OUTDIR "${{ vars.NCS_DOC_STORAGE_URL }}addons/addon-serial_modem?$NCS_DOC_SAS_MAIN" --recursive=true
5353
fi
5454
55-
- name: Upload Zoomin documentation
56-
if: >
57-
github.event.workflow_run.head_branch == 'main' &&
58-
github.event.workflow_run.head_repository.full_name == github.repository
59-
env:
60-
NCS_ZOOMIN_KEY: ${{ secrets.ZOOMIN_KEY }}
61-
run: |
62-
# trust server
63-
mkdir -p ~/.ssh
64-
ssh-keyscan ${{ vars.NCS_ZOOMIN_SERVER }} >> ~/.ssh/known_hosts
65-
66-
# prepare key
67-
touch zoomin_key
68-
chmod 600 zoomin_key
69-
echo "${{ secrets.ZOOMIN_KEY }}" > zoomin_key
70-
71-
# upload files
72-
for file in docs/addon-serial_modem*.zip; do
73-
sftp -v -i zoomin_key ${{ vars.NCS_ZOOMIN_USER }}@${{ vars.NCS_ZOOMIN_SERVER }} <<EOF
74-
cd docs-be.nordicsemi.com/sphinx-html/incoming
75-
put ${file}
76-
cd ../../../nordic-be-dev.zoominsoftware.io/sphinx-html/incoming
77-
put ${file}
78-
quit
79-
EOF
80-
done
81-
8255
- name: Find Comment
8356
if: ${{ github.event.workflow_run.event == 'pull_request' }}
8457
uses: peter-evans/find-comment@3eae4d37986fb5a8592848f6a574fdf654e61f9e # v3

doc/conf.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,11 @@
3838
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
3939

4040
html_theme = 'sphinx_ncs_theme'
41+
html_show_sphinx = False
42+
43+
html_theme_options = {'docsets': {},"addons_url": "https://nrfconnect.github.io/ncs-app-index/","bare_metal_url": "","ncs_url": "https://nrfconnectdocs.nordicsemi.com/ncs/latest/nrf/index.htm", "ncs_label": "nRF Connect SDK Docs", "logo_url": "https://nordic-semiconductor.fluidtopics.net/"}
44+
45+
html_extra_path = ['versions.json']
4146

4247
## -- Options for Breathe ----------------------------------------------------
4348
# https://breathe.readthedocs.io/en/latest/index.html

doc/requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Sphinx==5.3.0
22
breathe==4.35.0
3-
sphinx-ncs-theme==0.7.4
3+
sphinx-ncs-theme<2.1
44
sphinx-tabs>=3.4
55
sphinx-togglebutton>=0.3.2
66
Pillow>=9.0.1

0 commit comments

Comments
 (0)