bartoszek/zephyr
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
bccc4e62f2
zephyr/doc
History
Gerard Marull-Paretas 41566e2502 doc: add support for linkcheck 
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>
2022-09-23 17:28:47 +00:00
..
_doxygen doc: Update HTML documentation Zephyr logo 2022-06-06 00:02:55 +09:00
_extensions/zephyr doc: extend application sphinx extension to support west arguments 2022-08-12 13:56:55 +02:00
_scripts doc: gen_devicetree_rest: Fix binding doc file name resolution 2022-07-25 15:18:27 +02:00
_static doc: Update PDF documentation Zephyr logo 2022-06-06 00:02:55 +09:00
_templates
build doc: dts: fix reference table of contents generation 2022-09-19 18:15:43 +02:00
connectivity net: lwm2m: API for multiple resource writing 2022-09-12 10:52:18 +00:00
contribute blobs: Document the submission process 2022-08-25 11:10:53 -04:00
develop doc: languages: c: Add formatted output section 2022-09-21 12:37:04 +02:00
hardware doc: hardware: peripherals: canbus: controller: add start/stop calls 2022-09-13 16:06:50 +00:00
images
introduction doc: mention MIPS architecture support 2022-01-24 17:11:42 -05:00
kernel ring_buffer: Introduce RING_BUF_ITEM_SIZEOF 2022-09-20 09:08:14 +00:00
project doc: gh: Add RFC to the list of mandatory labels 2022-06-30 17:01:58 -04:00
releases doc: delete dead JIRA links 2022-09-23 17:28:47 +00:00
security vulnerabilities: Add CVE information 2022-06-06 17:59:28 +02:00
services doc: smf: Fix SMF state machine creation example 2022-09-19 15:24:32 +02:00
templates
404.rst doc: Suggest filing GitHub issue for broken links 2022-04-28 10:26:03 +02:00
CMakeLists.txt doc: add support for linkcheck 2022-09-23 17:28:47 +00:00
conf.py doc: add support for linkcheck 2022-09-23 17:28:47 +00:00
glossary.rst doc: use :kconfig:option: domain role 2022-03-02 09:28:37 +01:00
index-tex.rst doc: get rid of reference section 2022-04-07 16:35:19 +02:00
index.rst doc: get rid of reference section 2022-04-07 16:35:19 +02:00
kconfig.rst doc: use new kconfig extension 2022-03-02 09:28:37 +01:00
known-warnings.txt doc: Bluetooth: Document the services APIs 2022-05-24 17:49:17 +02:00
LICENSING.rst
Makefile doc: add support for linkcheck 2022-09-23 17:28:47 +00:00
substitutions.txt
zephyr.doxyfile.in doc: doxygen: fix Kconfig alias when using HTML output 2022-09-19 10:02:48 +00:00