From: Aaron Lauterer <a.lauterer@proxmox.com>
To: pbs-devel@lists.proxmox.com
Subject: [pbs-devel] [PATCH proxmox-backup 2/2] docs/scanrefs: fix handling if ref is same as headline
Date: Fri, 5 Feb 2021 16:10:30 +0100 [thread overview]
Message-ID: <20210205151030.28946-2-a.lauterer@proxmox.com> (raw)
In-Reply-To: <20210205151030.28946-1-a.lauterer@proxmox.com>
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 <a.lauterer@proxmox.com>
---
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
next prev parent reply other threads:[~2021-02-05 15:11 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-02-05 15:10 [pbs-devel] [PATCH proxmox-backup 1/2] docs: fix references to changed refs Aaron Lauterer
2021-02-05 15:10 ` Aaron Lauterer [this message]
2021-02-06 8:22 ` [pbs-devel] [PATCH proxmox-backup 2/2] docs/scanrefs: fix handling if ref is same as headline Thomas Lamprecht
2021-02-08 16:06 ` Aaron Lauterer
2021-02-06 7:49 ` [pbs-devel] applied: [PATCH proxmox-backup 1/2] docs: fix references to changed refs Dietmar Maurer
2021-02-06 8:12 ` [pbs-devel] " Thomas Lamprecht
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210205151030.28946-2-a.lauterer@proxmox.com \
--to=a.lauterer@proxmox.com \
--cc=pbs-devel@lists.proxmox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox