Skip to content

Commit c4389ef

Browse files
committed
doc: Add new theme to docs
Add new theme to docs. Minor updates to doc publishing so that docs upload under the addons folder in the Azure. Signed-off-by: divya pillai <divya.pillai@nordicsemi.no>
1 parent 5630e66 commit c4389ef

4 files changed

Lines changed: 13 additions & 10 deletions

File tree

.github/workflows/doc-publish.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,9 @@ jobs:
4747
NCS_DOC_SAS_MAIN: ${{ secrets.NCS_DOC_SAS_MAIN }}
4848
run: |
4949
if [[ "${{ github.event.workflow_run.event }}" == "pull_request" ]]; then
50-
azcopy cp $OUTDIR "${{ vars.NCS_DOC_PR_STORAGE_URL }}addon-serial_modem?$NCS_DOC_SAS_PRS" --recursive=true
50+
azcopy cp $OUTDIR "${{ vars.NCS_DOC_PR_STORAGE_URL }}addons/addon-serial_modem?$NCS_DOC_SAS_PRS" --recursive=true
5151
else
52-
azcopy cp $OUTDIR "${{ vars.NCS_DOC_STORAGE_URL }}addon-serial_modem?$NCS_DOC_SAS_MAIN" --recursive=true
52+
azcopy cp $OUTDIR "${{ vars.NCS_DOC_STORAGE_URL }}addons/addon-serial_modem?$NCS_DOC_SAS_MAIN" --recursive=true
5353
fi
5454
5555
- name: Upload Zoomin documentation
@@ -95,5 +95,5 @@ jobs:
9595
comment-id: ${{ steps.fc.outputs.comment-id }}
9696
issue-number: ${{ env.PR }}
9797
body: |
98-
You can find the documentation preview for this PR [here](${{ vars.NCS_DOC_PR_HOSTING_URL }}addon-serial_modem/PR-${{ env.PR }}/).
98+
You can find the documentation preview for this PR [here](${{ vars.NCS_DOC_PR_HOSTING_URL }}addons/addon-serial_modem/PR-${{ env.PR }}/).
9999
edit-mode: replace

doc/conf.py

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
1111

1212
project = 'ncs-serial-modem'
13-
copyright = '2025, Nordic Semiconductor'
13+
copyright = '2026, Nordic Semiconductor'
1414
author = 'Nordic Semiconductor'
1515
release = '0.1.0'
1616

@@ -27,6 +27,8 @@
2727
'breathe',
2828
'sphinx_tabs.tabs',
2929
'sphinx_togglebutton',
30+
"sphinxcontrib.jquery",
31+
"sphinx_copybutton",
3032
]
3133

3234
templates_path = ['_templates']
@@ -36,9 +38,9 @@
3638
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
3739

3840
html_theme = 'sphinx_ncs_theme'
39-
html_theme_options = {
40-
'docsets': {},
41-
}
41+
html_show_sphinx = False
42+
43+
html_theme_options = {'docsets': {},"addons_url": "","bare_metal_url": "","ncs_url": "https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/index.html", "ncs_label": "nRF Connect SDK Docs", "logo_url": "https://docs.nordicsemi.com"}
4244

4345
html_extra_path = ['versions.json']
4446

doc/requirements.txt

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
Sphinx==5.3.0
22
breathe==4.35.0
3-
sphinx-ncs-theme<1.1
3+
git+https://github.com/nrfconnect/doc-sphinx-ncs-theme@refs/pull/27/merge#egg=sphinx-ncs-theme
44
sphinx-tabs>=3.4
55
sphinx-togglebutton>=0.3.2
66
Pillow>=9.0.1
7+
sphinxcontrib.jquery
8+
sphinx-copybutton

doc/versions.json

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,5 @@
22
"2.0.99",
33
"2.0.0-preview1",
44
"1.0.1",
5-
"1.0.0",
6-
"0.3.0"
5+
"1.0.0"
76
]

0 commit comments

Comments
 (0)