michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: add support for linkcheck

Browse source 
This patch adds support for the `linkcheck` Sphinx builder, so that we
can easily check for broken links in the documentation.

It can be run like this:

ninja linkcheck

Or, using the Makefile shim:

make linkcheck

All Zephyr Github issues links are ignored, since we have lots of these
URLs and they quickly hit GH rate limit. They have small chance to be
incorrect, so we should be ok.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
This commit is contained in:
Gerard Marull-Paretas 2022-09-23 15:51:29 +02:00 • committed by Fabio Baltieri
commit 41566e2502
3 changed files with 35 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

6
doc/conf.py
View file

@ -201,6 +201,12 @@ latex_documents = [
("index-tex", "zephyr.tex", "Zephyr Project Documentation", author, "manual"),
]
# -- Options for linkcheck ------------------------------------------------
linkcheck_ignore = [
r"https://github.com/zephyrproject-rtos/zephyr/issues/.*"
]
# -- Options for zephyr.doxyrunner plugin ---------------------------------
doxyrunner_doxygen = os.environ.get("DOXYGEN_EXECUTABLE", "doxygen")