diff --git a/docs/Doxyfile b/docs/Doxyfile index 1aabb012..7dc5692d 100644 --- a/docs/Doxyfile +++ b/docs/Doxyfile @@ -48,7 +48,7 @@ PROJECT_NAME = "NCS Example Application" # could be handy for archiving the generated documentation or if some version # control system is used. -PROJECT_NUMBER = 1.0.0 +PROJECT_NUMBER = 1.3.99 # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a @@ -1255,7 +1255,7 @@ IGNORE_PREFIX = # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output # The default value is: YES. -GENERATE_HTML = YES +GENERATE_HTML = NO # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of diff --git a/docs/conf.py b/docs/conf.py index 55c9d127..d2e6c8ca 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -10,9 +10,10 @@ # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information project = 'Zigbee R23 add-on for nRF Connect SDK' -copyright = '2025, Nordic Semiconductor' +copyright = '2026, Nordic Semiconductor' author = 'Nordic Semiconductor' -release = '1.0.0' +release = 'Latest' +version = 'Latest' # Paths @@ -28,21 +29,28 @@ 'sphinxcontrib.mscgen', 'sphinx_tabs.tabs', 'sphinx_togglebutton', - 'sphinx_copybutton', - 'page_filter', ] -# The root document. -root_doc = 'index' - templates_path = ['_templates'] -exclude_patterns = ['_build_sphinx', '_build_doxygen', 'venv', 'Thumbs.db', '.DS_Store'] +exclude_patterns = ['_build_sphinx', 'Thumbs.db', '.DS_Store'] # -- Options for HTML output ------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output html_theme = 'sphinx_ncs_theme' +html_theme_options = { + 'docsets': {}, + "ncs_url": "https://nrfconnectdocs.nordicsemi.com/ncs/latest/nrf/", + "ncs_label": "nRF Connect SDK Docs", + "addons_url": "https://nrfconnect.github.io/ncs-app-index/", + "bare_metal_url": "", + "logo_url": "https://docs.nordicsemi.com", +} + +html_show_sphinx = False +html_extra_path = ['versions.json'] + ## -- Options for Breathe ---------------------------------------------------- # https://breathe.readthedocs.io/en/latest/index.html # diff --git a/docs/requirements-doc.txt b/docs/requirements-doc.txt index 3d893a04..b01bee4c 100644 --- a/docs/requirements-doc.txt +++ b/docs/requirements-doc.txt @@ -1,34 +1,8 @@ -# Documentation build dependencies for ncs-zigbee Add-on - -# Sphinx core - pinned for theme compatibility -sphinx==4.5.0 - -# Sphinx theme - compatible with sphinx 4.x -sphinx-ncs-theme==0.7.4 - -# Sphinx extensions +sphinx>=7,<8 +sphinx-ncs-theme<2.1.0 sphinx-tabs>=3.4 sphinx-togglebutton>=0.3.2 sphinx-copybutton>=0.5.2 - -# Breathe for Doxygen integration -breathe>=4.30.0 - -# Diagram support -sphinxcontrib-mscgen>=0.6 - -# Sphinxcontrib packages - pinned for Sphinx 4.x compatibility -sphinxcontrib-applehelp==1.0.2 -sphinxcontrib-devhelp==1.0.2 -sphinxcontrib-htmlhelp==2.0.1 -sphinxcontrib-jsmath==1.0.1 -sphinxcontrib-qthelp==1.0.3 -sphinxcontrib-serializinghtml==1.1.5 - -# Jinja2 compatibility for Sphinx 4.x -Jinja2>=3.1.6 -MarkupSafe>=2.0.0,<2.2.0 - -# Other dependencies +sphinxcontrib-plantuml Pygments>=2.15.0 PyYAML>=5.4.1 diff --git a/docs/requirements.txt b/docs/requirements.txt index 54b2c9cf..6339129f 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,5 +1,5 @@ -Sphinx +sphinx>=7.2,<8.2 breathe -sphinx-ncs-theme==0.7.4 +sphinx-ncs-theme<2.1.0 sphinx-tabs>=3.4 sphinx-togglebutton diff --git a/docs/versions.json b/docs/versions.json index 5f516c78..0118b15c 100644 --- a/docs/versions.json +++ b/docs/versions.json @@ -1,7 +1,8 @@ [ - "1.3.0", - "1.2.1", - "1.2.0", - "1.1.0", - "1.0.0" + "1.3.99", + "1.3.0", + "1.2.1", + "1.2.0", + "1.1.0", + "1.0.0" ]