Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: nrf: some build instructions updates #17529

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

doc: nrf: some build instructions updates #17529

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ec5b80c
doc: nrf: remove warnings section from doc build
gmarull Sep 27, 2024
f7d7250
doc: nrf: add note about doxygen-only docsets
gmarull Sep 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 1 addition & 13 deletions doc/nrf/dev_model_and_contributions/documentation/build.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,7 @@ If you have not built all documentation sets before, it is recommended to run th

Here, *docset-name* is the name of the documentation set, for example, ``nrf``.
This target will build the :ref:`documentation sets <documentation_sets>` that are needed for *docset-name*.
Note that Doxygen-only docsets like ``nrfx`` do not have the ``-all`` target as they have no dependencies.

On subsequent builds, it is recommended to just run the following command:

Expand Down Expand Up @@ -146,16 +147,3 @@ To test the version drop-down locally, complete the following steps:
#. Access http://localhost:8000/latest/index.html with your browser to see the documentation.

To add other versions of the documentation to your local documentation output, build the versions from a tagged release and rename the :file:`html` folder to the respective version (for example, |release_number_tt|).

Dealing with warnings
*********************

When building the documentation, all warnings are regarded as errors, so they will make the documentation build fail.

However, there are some known issues with Sphinx and Breathe that generate Sphinx warnings even though the input is valid C code.
To deal with such unavoidable warnings, Zephyr provides the Sphinx extension ``zephyr.warnings_filter`` that filters out warnings based on a set of regular expressions.
You can find the extension together with usage details at :file:`ncs/zephyr/doc/_extensions/zephyr/warnings_filter.py`.

The configuration file that defines the expected warnings for the nrf documentation set is located at :file:`ncs/nrf/doc/nrf/known-warnings.txt`.
It contains regular expressions to filter out warnings related to duplicate C declarations.
These warnings are caused by different objects (for example, a struct and a function or nested elements) sharing the same name.
Loading