Skip to content

Commit 51bebe8

Browse files
gmarullcarlescufi
authored andcommitted
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 <[email protected]>
1 parent de6af00 commit 51bebe8

File tree

8 files changed

+2
-58
lines changed

8 files changed

+2
-58
lines changed

doc/conf.py

+1-11
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
# -- General configuration ---------------------------------------------------
1515
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
1616

17-
extensions = ['sphinx.ext.intersphinx', 'breathe']
17+
extensions = ['sphinx.ext.intersphinx']
1818

1919
templates_path = ['_templates']
2020
exclude_patterns = ['_build_sphinx', 'Thumbs.db', '.DS_Store']
@@ -28,13 +28,3 @@
2828
# https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html
2929

3030
intersphinx_mapping = {'zephyr': ('https://docs.zephyrproject.org/latest/', None)}
31-
32-
## -- Options for Breathe ----------------------------------------------------
33-
# https://breathe.readthedocs.io/en/latest/index.html
34-
#
35-
# WARNING: please, check breathe maintainership status before using this
36-
# extension in production!
37-
38-
breathe_projects = {'example-application': '_build_doxygen/xml'}
39-
breathe_default_project = 'example-application'
40-
breathe_default_members = ('members', )

doc/drivers/blink.rst

-14
This file was deleted.

doc/drivers/index.rst

-9
This file was deleted.

doc/index.rst

-2
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,6 @@ This is a simple Sphinx documentation setup for ``example-application``.
77
:maxdepth: 2
88
:caption: Contents
99

10-
drivers/index
11-
lib/index
1210
zephyr
1311

1412
Indices and tables

doc/lib/custom.rst

-11
This file was deleted.

doc/lib/index.rst

-9
This file was deleted.

doc/requirements.txt

-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1 @@
11
Sphinx
2-
breathe

doc/zephyr.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@ Zephyr
22
======
33

44
You can reference Zephyr documentation items, like
5-
:external+zephyr:ref:`getting_started` or :external+zephyr:c:func:`k_sleep`.
5+
:external+zephyr:ref:`getting_started`.

0 commit comments

Comments
 (0)