IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Add b/w compatibility xfileref_role, with a DeprecationWarning.

Browse Source
This commit is contained in:
Georg Brandl 2009-08-09 20:32:18 +02:00
parent 4cb2faeb9c
commit af87d555ee
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
sphinx/roles.py
View File

@ -10,6 +10,7 @@
"""
import re
import warnings
from docutils import nodes, utils
from docutils.parsers.rst import roles
@ -40,6 +41,8 @@ for rolename, nodeclass in generic_docroles.iteritems():
# -- generic cross-reference roles ---------------------------------------------
class XRefRole(object):
"""XXX add docstring"""
nodeclass = addnodes.pending_xref
innernodeclass = nodes.literal
@ -230,3 +233,8 @@ for rolename, func in specific_docroles.iteritems():
roles.register_local_role(rolename, func)
# compatibility alias
def xfileref_role(*args, **kwds):
warnings.warn('xfileref_role is deprecated, use XRefRole',
DeprecationWarning, stacklevel=2)
return XRefRole()(*args, **kwds)