Skip to content

Commit c3ed720

Browse files
b-gentb-gent
committed
doc: new doc theme for Zigbee R23 doc
Sphinx updates to build doc using new theme for new portal. Signed-off-by: Bartosz Gentkowski <bartosz.gentkowski@nordicsemi.no>
1 parent 1585450 commit c3ed720

6 files changed

Lines changed: 30 additions & 47 deletions

File tree

‎docs/Doxyfile‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ PROJECT_NAME = "NCS Example Application"
4848
# could be handy for archiving the generated documentation or if some version
4949
# control system is used.
5050

51-
PROJECT_NUMBER = 1.0.0
51+
PROJECT_NUMBER = 1.3.99
5252

5353
# Using the PROJECT_BRIEF tag one can provide an optional one line description
5454
# for a project that appears at the top of each page and should give viewer a
@@ -1255,7 +1255,7 @@ IGNORE_PREFIX =
12551255
# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
12561256
# The default value is: YES.
12571257

1258-
GENERATE_HTML = YES
1258+
GENERATE_HTML = NO
12591259

12601260
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
12611261
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of

‎docs/conf.py‎

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

1212
project = 'Zigbee R23 add-on for nRF Connect SDK'
13-
copyright = '2025, Nordic Semiconductor'
13+
copyright = '2026, Nordic Semiconductor'
1414
author = 'Nordic Semiconductor'
15-
release = '1.0.0'
15+
release = 'Latest'
16+
version = 'Latest'
1617

1718
# Paths
1819

@@ -28,21 +29,28 @@
2829
'sphinxcontrib.mscgen',
2930
'sphinx_tabs.tabs',
3031
'sphinx_togglebutton',
31-
'sphinx_copybutton',
32-
'page_filter',
3332
]
3433

35-
# The root document.
36-
root_doc = 'index'
37-
3834
templates_path = ['_templates']
39-
exclude_patterns = ['_build_sphinx', '_build_doxygen', 'venv', 'Thumbs.db', '.DS_Store']
35+
exclude_patterns = ['_build_sphinx', 'Thumbs.db', '.DS_Store']
4036

4137
# -- Options for HTML output -------------------------------------------------
4238
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
4339

4440
html_theme = 'sphinx_ncs_theme'
4541

42+
html_theme_options = {
43+
'docsets': {},
44+
"ncs_url": "https://nrfconnectdocs.nordicsemi.com/ncs/latest/nrf/",
45+
"ncs_label": "nRF Connect SDK Docs",
46+
"addons_url": "https://nrfconnect.github.io/ncs-app-index/",
47+
"bare_metal_url": "",
48+
"logo_url": "https://docs.nordicsemi.com",
49+
}
50+
51+
html_show_sphinx = False
52+
html_extra_path = ['versions.json']
53+
4654
## -- Options for Breathe ----------------------------------------------------
4755
# https://breathe.readthedocs.io/en/latest/index.html
4856
#

‎docs/requirements-doc.txt‎

Lines changed: 3 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,8 @@
1-
# Documentation build dependencies for ncs-zigbee Add-on
2-
3-
# Sphinx core - pinned for theme compatibility
4-
sphinx==4.5.0
5-
6-
# Sphinx theme - compatible with sphinx 4.x
7-
sphinx-ncs-theme==0.7.4
8-
9-
# Sphinx extensions
1+
sphinx>=7,<8
2+
sphinx-ncs-theme<2.1.0
103
sphinx-tabs>=3.4
114
sphinx-togglebutton>=0.3.2
125
sphinx-copybutton>=0.5.2
13-
14-
# Breathe for Doxygen integration
15-
breathe>=4.30.0
16-
17-
# Diagram support
18-
sphinxcontrib-mscgen>=0.6
19-
20-
# Sphinxcontrib packages - pinned for Sphinx 4.x compatibility
21-
sphinxcontrib-applehelp==1.0.2
22-
sphinxcontrib-devhelp==1.0.2
23-
sphinxcontrib-htmlhelp==2.0.1
24-
sphinxcontrib-jsmath==1.0.1
25-
sphinxcontrib-qthelp==1.0.3
26-
sphinxcontrib-serializinghtml==1.1.5
27-
28-
# Jinja2 compatibility for Sphinx 4.x
29-
Jinja2>=3.1.6
30-
MarkupSafe>=2.0.0,<2.2.0
31-
32-
# Other dependencies
6+
sphinxcontrib-plantuml
337
Pygments>=2.15.0
348
PyYAML>=5.4.1

‎docs/requirements.txt‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Sphinx
1+
sphinx>=7.2,<8.2
22
breathe
3-
sphinx-ncs-theme==0.7.4
3+
sphinx-ncs-theme<2.1.0
44
sphinx-tabs>=3.4
55
sphinx-togglebutton

‎docs/setup.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Requirements and setup
44
######################
55

6-
This page outlines the requirements that you need to meet before you start working with the experimental support release of |addon| and Zigbee R23 protocol.
6+
This page outlines the requirements that you need to meet before you start working with the |addon| and Zigbee R23 protocol.
77

88
Hardware requirements
99
*********************

‎docs/versions.json‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
[
2-
"1.3.0",
3-
"1.2.1",
4-
"1.2.0",
5-
"1.1.0",
6-
"1.0.0"
2+
"1.3.99",
3+
"1.3.0",
4+
"1.2.1",
5+
"1.2.0",
6+
"1.1.0",
7+
"1.0.0"
78
]

0 commit comments

Comments
 (0)