Skip to content

Commit d099b86

Browse files
committed
doc: remove all traces of Breathe
So we can finally _breathe_. Signed-off-by: Gerard Marull-Paretas <[email protected]>
1 parent 881d39f commit d099b86

File tree

4 files changed

+4
-13
lines changed

4 files changed

+4
-13
lines changed

doc/nrf/dev_model_and_contributions/documentation/styleguide.rst

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -106,28 +106,26 @@ For example, on this page, the ``|gl|`` tag is defined for local usage and will
106106
This tag is not available on other pages.
107107
The page is also using the ``|NCS|`` tag that is defined in :file:`shortcuts.txt` and can be used on all documentation pages in the |NCS| project.
108108

109-
Breathe
110-
-------
109+
Doxybridge
110+
----------
111111

112-
The Breathe Sphinx plugin provides a bridge between RST and doxygen.
112+
The Doxybridge Sphinx plugin provides a bridge between RST and doxygen.
113113

114114
The doxygen documentation is not automatically included in RST.
115115
Therefore, every group must be explicitly added to an RST file.
116116
For example, the code below adds the ``bluetooth_throughput`` group to the RST document, and includes the public members of any classes in the group.
117-
The `Breathe documentation`_ contains information about what you can link to and how to do it.
118117

119118
.. code-block:: none
120119
121120
.. doxygengroup:: bluetooth_throughput
122121
123-
124122
.. note::
125123
Including a group on a page does not include all its subgroups automatically.
126124
To include subgroups, add the ``:inner:`` option.
127125

128126
However, if subgroups are defined in separate files, you should rather list them manually on the page of the group they belong to, so that you can include information on where they are defined.
129127

130-
To link directly to a doxygen reference from RST, use the following Breathe domains:
128+
To link directly to a doxygen reference from RST, use the following C domain roles:
131129

132130
* Function: ``:c:func:``
133131
* Structure: ``:c:struct:``

doc/nrf/installation/recommended_versions.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -296,8 +296,6 @@ They can all be installed using the ``doc/requirements.txt`` file using ``pip``.
296296
- Version
297297
* - azure-storage-blob
298298
- :ncs-tool-version:`AZURE_STORAGE_BLOB_VERSION`
299-
* - breathe
300-
- :ncs-tool-version:`BREATHE_VERSION`
301299
* - m2r2
302300
- :ncs-tool-version:`M2R2_VERSION`
303301
* - PyYAML

doc/nrf/links.txt

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -115,8 +115,6 @@
115115
.. _`Joiner CLI commands`: https://github.com/openthread/openthread/blob/main/src/cli/README_JOINER.md
116116
.. _`BBTC Client`: https://github.com/nrfconnect/sdk-openthread/tree/main/tools/tcat_ble_client
117117

118-
.. _`Breathe issue #437`: https://github.com/michaeljones/breathe/issues/437
119-
.. _`Breathe issue #438`: https://github.com/michaeljones/breathe/issues/438
120118
.. _`Sphinx parser issue`: https://github.com/sphinx-doc/sphinx/issues/2683
121119

122120
.. _`Leshan Demo Server`: https://github.com/eclipse/leshan/blob/master/README.md
@@ -1355,8 +1353,6 @@
13551353

13561354
.. ### Source: *.readthedocs.io
13571355

1358-
.. _`Breathe documentation`: https://breathe.readthedocs.io/en/latest/directives.html#directives
1359-
13601356
.. _`IntelHex`: https://python-intelhex.readthedocs.io/en/latest/
13611357

13621358
.. _`Requests`: https://requests.readthedocs.io/en/latest/

doc/requirements.txt

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@
77

88
# Extension | NCS | Kconfig | Matter | MCUboot | nrfxlib | TF-M | Zephyr |
99
azure-storage-blob # | X | | | | | | |
10-
breathe # | | | | | | | |
1110
doxmlparser # | | | | | | | X |
1211
m2r2 # | | | | | | | |
1312
PyYAML # | X | | | | | | X |

0 commit comments

Comments
 (0)