diff options
authorPeter Maydell <peter.maydell@linaro.org>2019-05-21 11:09:41 +0100
committerPeter Maydell <peter.maydell@linaro.org>2019-05-21 11:12:08 +0100
commit2cc24a2785d7a90668cf1af6ebb49d7624b3564f (patch)
parent104903dade4bdcc6ea829dd7f56c073d5491d800 (diff)
docs/conf.py: Ignore some missing references in nitpick mode
We enable Sphinx's 'nitpick' mode via the command line -n switch, which means it warns about references to things it doesn't know about. Add a whitelist of expected-not-to-be-present types, to avoid false positives when C function prototypes use standard integer types. If this whitelist gets too long and unmanageable we might be better off switching to non-nitpick mode instead. Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/conf.py b/docs/conf.py
index 9109edbcb9..388299fb25 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -114,6 +114,17 @@ todo_include_todos = False
# with "option::" in the document being processed. Turn that off.
suppress_warnings = ["ref.option"]
+nitpick_ignore = [
+ ("c:type", "int8_t"),
+ ("c:type", "int16_t"),
+ ("c:type", "int32_t"),
+ ("c:type", "int64_t"),
+ ("c:type", "uint8_t"),
+ ("c:type", "uint16_t"),
+ ("c:type", "uint32_t"),
+ ("c:type", "uint64_t"),
# -- Options for HTML output ----------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for