Skip to content

doc: Add new theme to docs #299

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
trantanen merged 1 commit into from
May 21, 2026
Merged

doc: Add new theme to docs #299

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .github/workflows/doc-publish.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,9 @@ jobs:
NCS_DOC_SAS_MAIN: ${{ secrets.NCS_DOC_SAS_MAIN }}
run: |
if [[ "${{ github.event.workflow_run.event }}" == "pull_request" ]]; then
azcopy cp $OUTDIR "${{ vars.NCS_DOC_PR_STORAGE_URL }}addon-serial_modem?$NCS_DOC_SAS_PRS" --recursive=true
azcopy cp $OUTDIR "${{ vars.NCS_DOC_PR_STORAGE_URL }}addons/addon-serial_modem?$NCS_DOC_SAS_PRS" --recursive=true
else
azcopy cp $OUTDIR "${{ vars.NCS_DOC_STORAGE_URL }}addon-serial_modem?$NCS_DOC_SAS_MAIN" --recursive=true
azcopy cp $OUTDIR "${{ vars.NCS_DOC_STORAGE_URL }}addons/addon-serial_modem?$NCS_DOC_SAS_MAIN" --recursive=true
fi

- name: Upload Zoomin documentation
Expand Down Expand Up @@ -95,5 +95,5 @@ jobs:
comment-id: ${{ steps.fc.outputs.comment-id }}
issue-number: ${{ env.PR }}
body: |
You can find the documentation preview for this PR [here](${{ vars.NCS_DOC_PR_HOSTING_URL }}addon-serial_modem/PR-${{ env.PR }}/).
You can find the documentation preview for this PR [here](${{ vars.NCS_DOC_PR_HOSTING_URL }}addons/addon-serial_modem/PR-${{ env.PR }}/).
edit-mode: replace
10 changes: 6 additions & 4 deletions doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information

project = 'ncs-serial-modem'
copyright = '2025, Nordic Semiconductor'
copyright = '2026, Nordic Semiconductor'
author = 'Nordic Semiconductor'
release = '0.1.0'

Expand All @@ -27,6 +27,8 @@
'breathe',
'sphinx_tabs.tabs',
'sphinx_togglebutton',
"sphinxcontrib.jquery",
"sphinx_copybutton",
]

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

html_theme = 'sphinx_ncs_theme'
html_theme_options = {
'docsets': {},
}
html_show_sphinx = False

html_theme_options = {'docsets': {},"addons_url": "https://nrfconnect.github.io/ncs-app-index/","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"}

html_extra_path = ['versions.json']

Expand Down
4 changes: 3 additions & 1 deletion doc/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
Sphinx==5.3.0
breathe==4.35.0
sphinx-ncs-theme<1.1
sphinx-ncs-theme<2.1
sphinx-tabs>=3.4
sphinx-togglebutton>=0.3.2
Pillow>=9.0.1
sphinxcontrib.jquery
sphinx-copybutton
3 changes: 1 addition & 2 deletions doc/versions.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,5 @@
"2.0.99",
"2.0.0-preview1",
"1.0.1",
"1.0.0",
"0.3.0"
"1.0.0"
]
Loading