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

Make token references work as hyperlinks again in LaTeX output.

Browse Source
This commit is contained in:
Georg Brandl 2011-01-15 10:52:56 +01:00
parent 9bd6d74109
commit d7c021bc5f
4 changed files with 12 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CHANGES
View File

@ -1,6 +1,8 @@
Release 1.0.7 (in development) Release 1.0.7 (in development)
============================== ==============================
* Make token references work as hyperlinks again in LaTeX output.
* #572: Show warnings by default when reference labels cannot be * #572: Show warnings by default when reference labels cannot be
found. found.

4
sphinx/builders/latex.py
View File

@ -46,10 +46,6 @@ class LaTeXBuilder(Builder):
return 'all documents' # for now return 'all documents' # for now
def get_target_uri(self, docname, typ=None): def get_target_uri(self, docname, typ=None):
if typ == 'token':
# token references are always inside production lists and must be
# replaced by \token{} in LaTeX
return '@token'
if docname not in self.docnames: if docname not in self.docnames:
raise NoUri raise NoUri
else: else:

19
sphinx/texinputs/sphinx.sty
View File

@ -237,21 +237,12 @@
\addtolength{\py@argswidth}{\linewidth}% \addtolength{\py@argswidth}{\linewidth}%
\item[#1\code{(}\py@sigparams{#2}{#3}]} \item[#1\code{(}\py@sigparams{#2}{#3}]}
% This version is being checked in for the historical record; it shows % Production lists
% how I've managed to get some aspects of this to work. It will not
% be used in practice, so a subsequent revision will change things
% again. This version has problems, but shows how to do something
% that proved more tedious than I'd expected, so I don't want to lose
% the example completely.
% %
\newcommand{\grammartoken}[1]{\texttt{#1}} \newenvironment{productionlist}{
\newenvironment{productionlist}[1][\@undefined]{ % \def\optional##1{{\Large[}##1{\Large]}}
\def\optional##1{{\Large[}##1{\Large]}} \def\production##1##2{\\\code{##1}&::=&\code{##2}}
\def\production##1##2{\hypertarget{grammar-token-##1}{}% \def\productioncont##1{\\& &\code{##1}}
\code{##1}&::=&\code{##2}\\}
\def\productioncont##1{& &\code{##1}\\}
\def\token##1{##1}
\let\grammartoken=\token
\parindent=2em \parindent=2em
\indent \indent
\begin{tabular}{lcl} \begin{tabular}{lcl}

15
sphinx/writers/latex.py
View File

@ -266,10 +266,10 @@ class LaTeXTranslator(nodes.NodeVisitor):
'\\label{%s}' % self.idescape(id) '\\label{%s}' % self.idescape(id)
def hyperlink(self, id): def hyperlink(self, id):
return '{\\hyperref[%s]{' % (self.idescape(id)) return '{\\hyperref[%s]{' % self.idescape(id)
def hyperpageref(self, id): def hyperpageref(self, id):
return '\\autopageref*{%s}' % (self.idescape(id)) return '\\autopageref*{%s}' % self.idescape(id)
def idescape(self, id): def idescape(self, id):
return str(unicode(id).translate(tex_replace_map)) return str(unicode(id).translate(tex_replace_map))
@ -422,8 +422,9 @@ class LaTeXTranslator(nodes.NodeVisitor):
def visit_production(self, node): def visit_production(self, node):
if node['tokenname']: if node['tokenname']:
self.body.append('\\production{%s}{' % tn = node['tokenname']
self.encode(node['tokenname'])) self.body.append(self.hypertarget('grammar-token-' + tn))
self.body.append('\\production{%s}{' % self.encode(tn))
else: else:
self.body.append('\\productioncont{') self.body.append('\\productioncont{')
def depart_production(self, node): def depart_production(self, node):
@ -1133,12 +1134,6 @@ class LaTeXTranslator(nodes.NodeVisitor):
self.context.append('}} (%s)' % self.hyperpageref(id)) self.context.append('}} (%s)' % self.hyperpageref(id))
else: else:
self.context.append('}}') self.context.append('}}')
elif uri.startswith('@token'):
if self.in_production_list:
self.body.append('\\token{')
else:
self.body.append('\\grammartoken{')
self.context.append('}')
else: else:
self.builder.warn('unusable reference target found: %s' % uri, self.builder.warn('unusable reference target found: %s' % uri,
(self.curfilestack[-1], node.line)) (self.curfilestack[-1], node.line))