From 0e307f8280eda4343a63c7faa2d52e33d46c9c0c Mon Sep 17 00:00:00 2001 From: Xavier Morel Date: Mon, 27 Aug 2018 12:55:21 +0200 Subject: [FIX] doc building and warnings doc: * fix incorrect doc comments (documenting params which don't exist) * correctly quote non-refs * fix role label syntax (backticks must be escaped) * add newline to fix warning JS doc parser: * fix handling of already-resolved objects * fix handling of non-string properties (e.g. foo[0] at module toplevel) * don't blow up if subject of .include call can't be resolved (just ignore) Others: * add translator support for ``problematic`` node (apparently used for some refs by recent Sphinx) --- doc/_extensions/autojsdoc/parser/parser.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) (limited to 'doc/_extensions/autojsdoc/parser/parser.py') diff --git a/doc/_extensions/autojsdoc/parser/parser.py b/doc/_extensions/autojsdoc/parser/parser.py index d979170bbc9..a5eb45a8e85 100644 --- a/doc/_extensions/autojsdoc/parser/parser.py +++ b/doc/_extensions/autojsdoc/parser/parser.py @@ -60,7 +60,7 @@ ref = collections.namedtuple('Ref', 'object property') def _name(r): bits = [] while isinstance(r, ref): - bits.append(r.property) + bits.append(str(r.property)) r = r.object return '.'.join(reversed(bits)) def deref(item, prop=None): @@ -348,7 +348,8 @@ class ModuleExtractor(Visitor): def resolve_extension(modules): t = target.become(modules) if not isinstance(t, jsdoc.ClassDoc): - raise ValueError("include() subjects should be classes, %s is %s" % (target_name, type(t))) + return # FIXME: log warning + # raise ValueError("include() subjects should be classes, %s is %s" % (target_name, type(t))) # TODO: note which module added these for it in items: if isinstance(it, dict): -- cgit v1.2.3