Skip to content

[MRG] DOC Avoid missing reference warnings, instead displaying as <code> #12970

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

Closed
thomasjpfan wants to merge 10 commits into from
Closed

[MRG] DOC Avoid missing reference warnings, instead displaying as <code> #12970

Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
61fe559
ENH: Filters out 'any' warnings
thomasjpfan Jan 13, 2019
86a75e7
ENH: Removes second fitler
thomasjpfan Jan 14, 2019
ca0c6b0
Merge remote-tracking branch 'upstream/master' into filter_any_warnings
thomasjpfan Jan 14, 2019
47bbf21
REV
thomasjpfan Jan 17, 2019
f0f329c
DOC: Ignores warnings role 'any' missing reference warnings
thomasjpfan Jan 17, 2019
2b18609
Merge remote-tracking branch 'upstream/master' into filter_any_warnings
thomasjpfan Jan 17, 2019
775025b
STY: Flake8
thomasjpfan Jan 17, 2019
6f2ebc1
RFC: Simplify
thomasjpfan Jan 18, 2019
fe19ee5
RFC: Removes xref
thomasjpfan Jan 18, 2019
22b8dbd
Merge remote-tracking branch 'upstream/master' into filter_any_warnings
thomasjpfan Jan 18, 2019
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
8 changes: 8 additions & 0 deletions doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -280,11 +280,19 @@ def make_carousel_thumbs(app, exception):
issues_user_uri = 'https://github.com/{user}'


def maps_any_missing_reference_to_code_block(app, env, node, contnode):
if node['reftype'] == 'any':
contnode['classes'] = []
Copy link
Copy Markdown
Member

@jnothman jnothman Jan 21, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you explain (and perhaps add a comment) how this results in code-like styling? Thanks.

return contnode
return None


def setup(app):
# to hide/show the prompt in code examples:
app.add_javascript('js/copybutton.js')
app.add_javascript('js/extra.js')
app.connect('build-finished', make_carousel_thumbs)
app.connect('missing-reference', maps_any_missing_reference_to_code_block)


# The following is used by sphinx.ext.linkcode to provide links to github
Expand Down