doc: nrfx: switch to Doxygen-only docset

We are now serving Doxygen content, so let's drop the redundant Sphinx
"shim".

Signed-off-by: Gerard Marull-Paretas <[email protected]>

Author: gmarull

.github/workflows/docbuild.yml

@@ -139,6 +139,26 @@ jobs:
             popd
           done
 
+          # Doxygen APIs standalone
+          declare -a DOXYGEN=("nrfx")
+
+          for docset in "${DOXYGEN[@]}"; do
+            OUTDIR=doc/_build/html/$docset
+
+            # Populate custom.properties, tags.yml
+            cp doc/_zoomin/$docset.apis.custom.properties "$OUTDIR/custom.properties"
+            sed -i 's/__VERSION__/'"$VERSION"'/g' "$OUTDIR/custom.properties"
+
+            cp doc/_zoomin/$docset.apis.tags.yml "$OUTDIR/tags.yml"
+            sed -i 's/__VERSION__/'"$VERSION"'/g' "$OUTDIR/tags.yml"
+
+            pushd "$OUTDIR"
+            ARCHIVE="$docset-apis-$VERSION.zip"
+            zip -rq "$ARCHIVE" .
+            mv "$ARCHIVE" "$ROOT"
+            popd
+          done
+
           # NCS
           OUTDIR=doc/_build/html
 

doc/CMakeLists.txt

@@ -50,6 +50,36 @@ file(MAKE_DIRECTORY ${KCONFIG_BINARY_DIR})
 #-------------------------------------------------------------------------------
 # Functions
 
+# Add a new Doxygen docset.
+#
+# Args:
+# - name: Docset name.
+# - sources: Sources.
+#
+# Configured targets:
+# - ${name}: Run Doxygen build.
+# - ${name}-clean: Clean build artifacts.
+#
+function(add_doxygen_docset name sources)
+  set(DOCSET_BUILD_DIR ${CMAKE_BINARY_DIR}/html)
+  set(DOCSET_SOURCE_BASE ${sources})
+
+  configure_file(${CMAKE_CURRENT_LIST_DIR}/${name}/${name}.doxyfile.in ${CMAKE_BINARY_DIR}/${name}.doxyfile)
+
+  add_custom_target(
+    ${name}
+    COMMAND ${CMAKE_COMMAND} -E make_directory ${DOCSET_BUILD_DIR}
+    COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_BINARY_DIR}/${name}.doxyfile
+    USES_TERMINAL
+    COMMENT "Building ${name} docset..."
+  )
+
+  add_custom_target(
+    ${name}-clean
+    COMMAND ${CMAKE_COMMAND} -E rm -rf ${DOCSET_BUILD_DIR}
+  )
+endfunction()
+
 # Add a new docset.
 #
 # Args:
@@ -223,7 +253,7 @@ add_docset(mcuboot)
 #-------------------------------------------------------------------------------
 # docset: nrfx
 
-add_docset(nrfx DODGY)
+add_doxygen_docset(nrfx ${ZEPHYR_HAL_NORDIC_MODULE_DIR})
 
 #-------------------------------------------------------------------------------
 # docset: tfm
@@ -274,7 +304,6 @@ add_custom_target(
 
 add_dependencies(merge-search-indexes
     nrf-all
-    nrfx-all
     nrfxlib-all
     zephyr-all
     mcuboot-all
@@ -297,7 +326,7 @@ add_dependencies(build-all
     copy-extra-content
     merge-search-indexes
     nrf-all
-    nrfx-all
+    nrfx
     nrfxlib-all
     zephyr-all
     mcuboot-all

doc/_utils/utils.py

@@ -21,7 +21,6 @@
 
 ALL_DOCSETS = {
     "nrf": ("nRF Connect SDK", "index", "manifest"),
-    "nrfx": ("nrfx", "index", "hal_nordic"),
     "nrfxlib": ("nrfxlib", "README", "nrfxlib"),
     "zephyr": ("Zephyr Project", "index", "zephyr"),
     "mcuboot": ("MCUboot", "wrapper", "mcuboot"),

doc/_zoomin/nrfx.apis.custom.properties

@@ -0,0 +1,2 @@
+manual.name=nrfx-apis-__VERSION__
+booktitle=nrfx APIs - __VERSION__

doc/_zoomin/nrfx.apis.tags.yml

@@ -0,0 +1,9 @@
+# Document tags for Zoomin.
+
+# Tags for all topics:
+mapping_global:
+  - nrfx-apis
+  - nrfx-apis-__VERSION__
+
+# Tags for individual topics:
+mapping_topics: []

doc/nrf/conf.py

@@ -110,10 +110,6 @@
 if kconfig_mapping:
     intersphinx_mapping["kconfig"] = kconfig_mapping
 
-nrfx_mapping = utils.get_intersphinx_mapping("nrfx")
-if nrfx_mapping:
-    intersphinx_mapping["nrfx"] = nrfx_mapping
-
 matter_mapping = utils.get_intersphinx_mapping("matter")
 if matter_mapping:
     intersphinx_mapping["matter"] = matter_mapping