doc: nrfxlib: replace breathe with doxybridge

gmarull · gmarull · commit 5806ef36a9d0 · 2024-09-26T10:23:14.000+02:00
Breathe will no longer be used.

Signed-off-by: Gerard Marull-Paretas &lt;gerard.marull@nordicsemi.no&gt;
diff --git a/.github/workflows/docbuild.yml b/.github/workflows/docbuild.yml
@@ -113,7 +113,7 @@ jobs:
           ROOT="$PWD"
 
           # Doxygen APIs combined with Sphinx
-          declare -a SPHINX_DOXYGEN=("nrf" "zephyr")
+          declare -a SPHINX_DOXYGEN=("nrf" "nrfxlib" "zephyr")
 
           mkdir doc/_build/html-doxygen
 
diff --git a/doc/_zoomin/nrfxlib.apis.custom.properties b/doc/_zoomin/nrfxlib.apis.custom.properties
@@ -0,0 +1,2 @@
+manual.name=nrfxlib-apis-__VERSION__
+booktitle=nrfxlib APIs - __VERSION__
diff --git a/doc/_zoomin/nrfxlib.apis.tags.yml b/doc/_zoomin/nrfxlib.apis.tags.yml
@@ -0,0 +1,9 @@
+# Document tags for Zoomin.
+
+# Tags for all topics:
+mapping_global:
+  - nrfxlib-apis
+  - nrfxlib-apis-__VERSION__
+
+# Tags for individual topics:
+mapping_topics: []
diff --git a/doc/nrfxlib/conf.py b/doc/nrfxlib/conf.py
@@ -33,13 +33,13 @@
 
 extensions = [
     "sphinx.ext.intersphinx",
-    "breathe",
     "sphinxcontrib.mscgen",
     "inventory_builder",
     "zephyr.kconfig",
     "zephyr.warnings_filter",
     "zephyr.external_content",
     "zephyr.doxyrunner",
+    "zephyr.doxybridge",
 ]
 master_doc = "README"
 
@@ -83,19 +83,16 @@
 
 doxyrunner_doxygen = os.environ.get("DOXYGEN_EXECUTABLE", "doxygen")
 doxyrunner_doxyfile = NRF_BASE / "doc" / "nrfxlib" / "nrfxlib.doxyfile.in"
-doxyrunner_outdir = utils.get_builddir() / "nrfxlib" / "doxygen"
+doxyrunner_outdir = utils.get_builddir() / "html" / "nrfxlib" / "doxygen"
 doxyrunner_fmt = True
 doxyrunner_fmt_vars = {
     "NRFXLIB_BASE": str(NRFXLIB_BASE),
     "OUTPUT_DIRECTORY": str(doxyrunner_outdir),
 }
 
-# Options for breathe ----------------------------------------------------------
+# -- Options for doxybridge plugin ---------------------------------------------
 
-breathe_projects = {"nrfxlib": str(doxyrunner_outdir / "xml")}
-breathe_default_project = "nrfxlib"
-breathe_domain_by_extension = {"h": "c", "c": "c"}
-breathe_separate_member_pages = True
+doxybridge_dir = doxyrunner_outdir
 
 # Options for external_content -------------------------------------------------
 
diff --git a/doc/nrfxlib/nrfxlib.doxyfile.in b/doc/nrfxlib/nrfxlib.doxyfile.in
@@ -1029,7 +1029,7 @@ IGNORE_PREFIX          =
 # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
 # The default value is: YES.
 
-GENERATE_HTML          = NO
+GENERATE_HTML          = YES
 
 # 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/doc/requirements.txt b/doc/requirements.txt
@@ -7,7 +7,7 @@
 
 # Extension                       | NCS | Kconfig | Matter | MCUboot | nrfx | nrfxlib | TF-M | Zephyr |
 azure-storage-blob              # |  X  |         |        |         |      |         |      |        |
-breathe                         # |     |         |        |         |      |    X    |      |        |
+breathe                         # |     |         |        |         |      |         |      |        |
 doxmlparser                     # |     |         |        |         |      |         |      |   X    |
 m2r2                            # |     |         |        |         |  X   |         |      |        |
 PyYAML                          # |  X  |         |        |         |      |         |      |   X    |

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+manual.name=nrfxlib-apis-__VERSION__`
	`2`	`+booktitle=nrfxlib APIs - __VERSION__`