Skip to content

FIX remove duplicated citation back-references #180

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 2 commits into from
Apr 2, 2019
Merged

FIX remove duplicated citation back-references #180

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fd6aeae
FIX remove duplicated citation back-references
jnothman Jun 6, 2018
c7b9439
Don't shadow builtin id
jnothman Jun 6, 2018
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
18 changes: 15 additions & 3 deletions numpydoc/numpydoc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@
import collections
import hashlib

from docutils.nodes import citation, Text
from docutils.nodes import citation, Text, reference
import sphinx
from sphinx.addnodes import pending_xref, desc_content
from sphinx.addnodes import pending_xref, desc_content, only

if sphinx.__version__ < '1.0.1':
raise RuntimeError("Sphinx 1.0.1 or newer is required")
Expand All @@ -43,7 +43,6 @@

HASH_LEN = 12


def rename_references(app, what, name, obj, options, lines):
# decorate reference numbers so that there are no duplicates
# these are later undecorated in the doctree, in relabel_references
Expand Down Expand Up @@ -103,6 +102,18 @@ def matching_pending_xref(node):
ref.replace(ref_text, new_text.copy())


def clean_backrefs(app, doc, docname):
# only::latex directive has resulted in citation backrefs without reference
known_ref_ids = set()
for ref in doc.traverse(reference, descend=True):
for id in ref['ids']:
known_ref_ids.add(id)
for citation_node in doc.traverse(citation, descend=True):
# remove backrefs to non-existant refs
citation_node['backrefs'] = [id for id in citation_node['backrefs']
if id in known_ref_ids]


DEDUPLICATION_TAG = ' !! processed by numpydoc !!'


Expand Down Expand Up @@ -179,6 +190,7 @@ def setup(app, get_doc_object_=get_doc_object):
app.connect('autodoc-process-docstring', mangle_docstrings)
app.connect('autodoc-process-signature', mangle_signature)
app.connect('doctree-read', relabel_references)
app.connect('doctree-resolved', clean_backrefs)
app.add_config_value('numpydoc_edit_link', None, False)
app.add_config_value('numpydoc_use_plots', None, False)
app.add_config_value('numpydoc_use_blockquotes', None, False)
Expand Down