Skip to content

Commit 56a6910

Browse files
simheinfabiobaltieri
authored andcommitted
doc: doc generation: remove breathe references
Remove the references to the breathe extension in the Schematic of the documentation build process graph and the filtering expected warnings section. Signed-off-by: Simon Hein <[email protected]>
1 parent b3a4b15 commit 56a6910

File tree

1 file changed

+3
-21
lines changed

1 file changed

+3
-21
lines changed

doc/contribute/documentation/generation.rst

Lines changed: 3 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ The project's documentation contains the following items:
5252
header [shape="rectangle" label="c header\ncomments"]
5353
xml [shape="rectangle" label="XML"]
5454
html [shape="rectangle" label="HTML\nweb site"]
55-
sphinx[shape="ellipse" label="sphinx +\nbreathe,\ndocutils"]
55+
sphinx[shape="ellipse" label="sphinx +\ndocutils"]
5656
images -> sphinx
5757
rst -> sphinx
5858
conf -> sphinx
@@ -65,8 +65,8 @@ The project's documentation contains the following items:
6565

6666

6767
The reStructuredText files are processed by the Sphinx documentation system,
68-
and make use of the breathe extension for including the doxygen-generated API
69-
material. Additional tools are required to generate the
68+
and make use of the doxygen-generated API material.
69+
Additional tools are required to generate the
7070
documentation locally, as described in the following sections.
7171

7272
.. _documentation-processors:
@@ -242,24 +242,6 @@ build the documentation directly from there:
242242
# To generate PDF output
243243
make pdf
244244
245-
Filtering expected warnings
246-
***************************
247-
248-
There are some known issues with Sphinx/Breathe that generate Sphinx warnings
249-
even though the input is valid C code. While these issues are being considered
250-
for fixing we have created a Sphinx extension that allows to filter them out
251-
based on a set of regular expressions. The extension is named
252-
``zephyr.warnings_filter`` and it is located at
253-
``doc/_extensions/zephyr/warnings_filter.py``. The warnings to be filtered out
254-
can be added to the ``doc/known-warnings.txt`` file.
255-
256-
The most common warning reported by Sphinx/Breathe is related to duplicate C
257-
declarations. This warning may be caused by different Sphinx/Breathe issues:
258-
259-
- Multiple declarations of the same object are not supported
260-
- Different objects (e.g. a struct and a function) can not share the same name
261-
- Nested elements (e.g. in a struct or union) can not share the same name
262-
263245
Developer-mode Document Building
264246
********************************
265247

0 commit comments

Comments
 (0)