From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by lists.proxmox.com (Postfix) with ESMTPS id 1E3EC60507 for ; Fri, 5 Feb 2021 16:11:03 +0100 (CET) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 026AAA9E3 for ; Fri, 5 Feb 2021 16:10:33 +0100 (CET) Received: from proxmox-new.maurer-it.com (proxmox-new.maurer-it.com [212.186.127.180]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by firstgate.proxmox.com (Proxmox) with ESMTPS id D5977A9CF for ; Fri, 5 Feb 2021 16:10:31 +0100 (CET) Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1]) by proxmox-new.maurer-it.com (Proxmox) with ESMTP id A0E20461F5 for ; Fri, 5 Feb 2021 16:10:31 +0100 (CET) From: Aaron Lauterer To: pbs-devel@lists.proxmox.com Date: Fri, 5 Feb 2021 16:10:30 +0100 Message-Id: <20210205151030.28946-2-a.lauterer@proxmox.com> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20210205151030.28946-1-a.lauterer@proxmox.com> References: <20210205151030.28946-1-a.lauterer@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 AWL -0.020 Adjusted score from AWL reputation of From: address KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment RCVD_IN_DNSWL_MED -2.3 Sender listed at https://www.dnswl.org/, medium trust SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record URIBL_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to URIBL was blocked. See http://wiki.apache.org/spamassassin/DnsBlocklists#dnsbl-block for more information. [proxmox-scanrefs.py] Subject: [pbs-devel] [PATCH proxmox-backup 2/2] docs/scanrefs: fix handling if ref is same as headline X-BeenThere: pbs-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox Backup Server development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 05 Feb 2021 15:11:03 -0000 If the ref is named the same as the headline (once normalized), sphinx will return a 'idX' value in node['ids'][1] which we use for the label ID. The headline is always present at index 0. Checking for that and using index 0 in case we do get a 'idX' helps us to avoid using the 'idX' as keys in our OnlineHelpInfo.js and actually use the intended key. Signed-off-by: Aaron Lauterer --- docs/_ext/proxmox-scanrefs.py | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/docs/_ext/proxmox-scanrefs.py b/docs/_ext/proxmox-scanrefs.py index 1b3c0615..0d626561 100644 --- a/docs/_ext/proxmox-scanrefs.py +++ b/docs/_ext/proxmox-scanrefs.py @@ -90,7 +90,18 @@ class ReflabelMapper(Builder): if hasattr(node, 'expect_referenced_by_id') and len(node['ids']) > 1: # explicit labels filename = self.env.doc2path(docname) filename_html = re.sub('.rst', '.html', filename) - labelid = node['ids'][1] # [0] is predefined by sphinx, we need [1] for explicit ones + + # node['ids'][0] contains a normalized version of the + # headline. If the ref and headline are the same + # (normalized) sphinx will set the node['ids'][1] to a + # generic id in the format `idX` where X is numeric. If the + # ref and headline are not the same, the ref name will be + # stored in node['ids'][1] + if re.match('^id[0-9]*$', node['ids'][1]): + labelid = node['ids'][0] + else: + labelid = node['ids'][1] + title = cast(nodes.title, node[0]) logger.info('traversing section {}'.format(title.astext())) ref_name = getattr(title, 'rawsource', title.astext()) -- 2.20.1