From 48ecd0dc557c073c4ab03983ed78fd2a9871be70 Mon Sep 17 00:00:00 2001
From: Gerard Marull-Paretas <gerard@teslabs.com>
Date: Mon, 14 Oct 2024 11:28:02 +0200
Subject: [PATCH] doc: remove breathe

Breathe is no longer used in Zephyr, mainly to its poor performance and
lack of proper maintainership. Therefore, do not recommend it in our
template application. Previous external C references do not work either,
so let's remove them. We may polish doxybridge/runner in the future and
make it a published extension on PyPI so that 3rd party repos like
applications can use it.

Signed-off-by: Gerard Marull-Paretas <gerard@teslabs.com>
---
 doc/conf.py           | 12 +-----------
 doc/drivers/blink.rst | 14 --------------
 doc/drivers/index.rst |  9 ---------
 doc/index.rst         |  2 --
 doc/lib/custom.rst    | 11 -----------
 doc/lib/index.rst     |  9 ---------
 doc/requirements.txt  |  1 -
 doc/zephyr.rst        |  2 +-
 8 files changed, 2 insertions(+), 58 deletions(-)
 delete mode 100644 doc/drivers/blink.rst
 delete mode 100644 doc/drivers/index.rst
 delete mode 100644 doc/lib/custom.rst
 delete mode 100644 doc/lib/index.rst

diff --git a/doc/conf.py b/doc/conf.py
index 0cb5ccca3..e4d8bfbb1 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -14,7 +14,7 @@
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
-extensions = ['sphinx.ext.intersphinx', 'breathe']
+extensions = ['sphinx.ext.intersphinx']
 
 templates_path = ['_templates']
 exclude_patterns = ['_build_sphinx', 'Thumbs.db', '.DS_Store']
@@ -28,13 +28,3 @@
 # https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html
 
 intersphinx_mapping = {'zephyr': ('https://docs.zephyrproject.org/latest/', None)}
-
-## -- Options for Breathe ----------------------------------------------------
-# https://breathe.readthedocs.io/en/latest/index.html
-#
-# WARNING: please, check breathe maintainership status before using this
-# extension in production!
-
-breathe_projects = {'example-application': '_build_doxygen/xml'}
-breathe_default_project = 'example-application'
-breathe_default_members = ('members', )
diff --git a/doc/drivers/blink.rst b/doc/drivers/blink.rst
deleted file mode 100644
index 8f67edfeb..000000000
--- a/doc/drivers/blink.rst
+++ /dev/null
@@ -1,14 +0,0 @@
-Blink
-=====
-
-.. doxygengroup:: drivers_blink
-
-Driver operations
------------------
-
-.. doxygengroup:: drivers_blink_ops
-
-Public API
-----------
-
-.. doxygengroup:: drivers_blink_api
diff --git a/doc/drivers/index.rst b/doc/drivers/index.rst
deleted file mode 100644
index a287e4198..000000000
--- a/doc/drivers/index.rst
+++ /dev/null
@@ -1,9 +0,0 @@
-Drivers
-=======
-
-.. doxygengroup:: drivers
-
-.. toctree::
-    :maxdepth: 1
-
-    blink
diff --git a/doc/index.rst b/doc/index.rst
index 54f0f0b12..3890d83ea 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -7,8 +7,6 @@ This is a simple Sphinx documentation setup for ``example-application``.
    :maxdepth: 2
    :caption: Contents
 
-   drivers/index
-   lib/index
    zephyr
 
 Indices and tables
diff --git a/doc/lib/custom.rst b/doc/lib/custom.rst
deleted file mode 100644
index b2261ef91..000000000
--- a/doc/lib/custom.rst
+++ /dev/null
@@ -1,11 +0,0 @@
-Custom
-======
-
-.. doxygengroup:: lib_custom
-    :desc-only:
-
-Public API
-----------
-
-.. doxygengroup:: lib_custom
-    :content-only:
\ No newline at end of file
diff --git a/doc/lib/index.rst b/doc/lib/index.rst
deleted file mode 100644
index 1e46b5a0b..000000000
--- a/doc/lib/index.rst
+++ /dev/null
@@ -1,9 +0,0 @@
-Libraries
-=========
-
-.. doxygengroup:: lib
-
-.. toctree::
-    :maxdepth: 1
-
-    custom
diff --git a/doc/requirements.txt b/doc/requirements.txt
index 7f360289c..2806c1649 100644
--- a/doc/requirements.txt
+++ b/doc/requirements.txt
@@ -1,2 +1 @@
 Sphinx
-breathe
diff --git a/doc/zephyr.rst b/doc/zephyr.rst
index 778ea28d0..7e4d19934 100644
--- a/doc/zephyr.rst
+++ b/doc/zephyr.rst
@@ -2,4 +2,4 @@ Zephyr
 ======
 
 You can reference Zephyr documentation items, like
-:external+zephyr:ref:`getting_started` or :external+zephyr:c:func:`k_sleep`.
\ No newline at end of file
+:external+zephyr:ref:`getting_started`.