Skip to content

Fix/enhance replacement of citation reference numbers to avoid duplicates #50

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Sep 14, 2016
Merged

Fix/enhance replacement of citation reference numbers to avoid duplicates #50

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e2f6842
Factor out function to rename references
sergiocallegari Mar 2, 2016
20decf6
Avoid sorting references by length while renaming
sergiocallegari Mar 2, 2016
e577341
Make citation pattern configurable
sergiocallegari Mar 2, 2016
8ee66bd
Make default citation pattern more general
sergiocallegari Mar 2, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 30 additions & 24 deletions numpydoc/numpydoc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,33 @@
sixu = lambda s: unicode(s, 'unicode_escape')


def mangle_docstrings(app, what, name, obj, options, lines,
def rename_references(app, what, name, obj, options, lines,
reference_offset=[0]):
# replace reference numbers so that there are no duplicates
references = []
for line in lines:
line = line.strip()
m = re.match(sixu('^.. \\[(%s)\\]') % app.config.numpydoc_citation_re,
line, re.I)
if m:
references.append(m.group(1))

if references:
for i, line in enumerate(lines):
for r in references:
if re.match(sixu('^\\d+$'), r):
new_r = sixu("R%d") % (reference_offset[0] + int(r))
else:
new_r = sixu("%s%d") % (r, reference_offset[0])
lines[i] = lines[i].replace(sixu('[%s]_') % r,
sixu('[%s]_') % new_r)
lines[i] = lines[i].replace(sixu('.. [%s]') % r,
sixu('.. [%s]') % new_r)

reference_offset[0] += len(references)


def mangle_docstrings(app, what, name, obj, options, lines):

cfg = {'use_plots': app.config.numpydoc_use_plots,
'show_class_members': app.config.numpydoc_show_class_members,
Expand Down Expand Up @@ -70,29 +95,9 @@ def mangle_docstrings(app, what, name, obj, options, lines,
lines += [sixu(' %s') % x for x in
(app.config.numpydoc_edit_link % v).split("\n")]

# replace reference numbers so that there are no duplicates
references = []
for line in lines:
line = line.strip()
m = re.match(sixu('^.. \\[([a-z0-9_.-])\\]'), line, re.I)
if m:
references.append(m.group(1))

# start renaming from the longest string, to avoid overwriting parts
references.sort(key=lambda x: -len(x))
if references:
for i, line in enumerate(lines):
for r in references:
if re.match(sixu('^\\d+$'), r):
new_r = sixu("R%d") % (reference_offset[0] + int(r))
else:
new_r = sixu("%s%d") % (r, reference_offset[0])
lines[i] = lines[i].replace(sixu('[%s]_') % r,
sixu('[%s]_') % new_r)
lines[i] = lines[i].replace(sixu('.. [%s]') % r,
sixu('.. [%s]') % new_r)

reference_offset[0] += len(references)
# call function to replace reference numbers so that there are no
# duplicates
rename_references(app, what, name, obj, options, lines)


def mangle_signature(app, what, name, obj, options, sig, retann):
Expand Down Expand Up @@ -129,6 +134,7 @@ def setup(app, get_doc_object_=get_doc_object):
app.add_config_value('numpydoc_show_class_members', True, True)
app.add_config_value('numpydoc_show_inherited_class_members', True, True)
app.add_config_value('numpydoc_class_members_toctree', True, True)
app.add_config_value('numpydoc_citation_re', '[a-z0-9_.-]+', True)

# Extra mangling domains
app.add_domain(NumpyPythonDomain)
Expand Down