From b4d0a9dc9a7475c9fe1787ffd7ca23ddbe74e3b2 Mon Sep 17 00:00:00 2001 From: Georg Brandl Date: Thu, 16 Oct 2008 20:33:59 +0000 Subject: [PATCH] Remove the "ni" environments; they are useless now that index entries are always inserted separately. Fixes #4132. --- CHANGES | 2 ++ sphinx/latexwriter.py | 9 +++-- sphinx/texinputs/sphinx.sty | 72 ++++--------------------------------- 3 files changed, 12 insertions(+), 71 deletions(-) diff --git a/CHANGES b/CHANGES index 2fb0c3c0c..e541d630f 100644 --- a/CHANGES +++ b/CHANGES @@ -116,6 +116,8 @@ Bugs fixed * Properly escape quotes in HTML help attribute values. +* Fix LaTeX build for some description environments with ``:noindex:``. + Release 0.4.3 (Oct 8, 2008) =========================== diff --git a/sphinx/latexwriter.py b/sphinx/latexwriter.py index 8a8299b72..5a182f40f 100644 --- a/sphinx/latexwriter.py +++ b/sphinx/latexwriter.py @@ -106,7 +106,6 @@ class Table(object): class Desc(object): def __init__(self, node): self.env = LaTeXTranslator.desc_map.get(node['desctype'], 'describe') - self.ni = node['noindex'] self.type = self.cls = self.name = self.params = self.annotation = '' self.count = 0 @@ -382,7 +381,7 @@ class LaTeXTranslator(nodes.NodeVisitor): self.descstack.append(Desc(node)) def depart_desc(self, node): d = self.descstack.pop() - self.body.append("\\end{%s%s}\n" % (d.env, d.ni and 'ni' or '')) + self.body.append("\\end{%s}\n" % d.env) def visit_desc_signature(self, node): d = self.descstack[-1] @@ -396,13 +395,13 @@ class LaTeXTranslator(nodes.NodeVisitor): else: hyper = '' if d.count == 0: - t1 = "\n\n%s\\begin{%s%s}" % (hyper, d.env, (d.ni and 'ni' or '')) + t1 = "\n\n%s\\begin{%s}" % (hyper, d.env) else: - t1 = "\n%s\\%sline%s" % (hyper, d.env[:-4], (d.ni and 'ni' or '')) + t1 = "\n%s\\%sline" % (hyper, d.env[:-4]) d.count += 1 if d.env in ('funcdesc', 'classdesc', 'excclassdesc'): t2 = "{%s}{%s}" % (d.name, d.params) - elif d.env in ('datadesc', 'classdesc*', 'excdesc', 'csimplemacrodesc'): + elif d.env in ('datadesc', 'excdesc', 'csimplemacrodesc'): t2 = "{%s}" % (d.name) elif d.env in ('methoddesc', 'staticmethoddesc'): if d.cls: diff --git a/sphinx/texinputs/sphinx.sty b/sphinx/texinputs/sphinx.sty index 9785fbcdd..5b137a2cb 100644 --- a/sphinx/texinputs/sphinx.sty +++ b/sphinx/texinputs/sphinx.sty @@ -414,20 +414,12 @@ % simple functions (not methods) ----------------------------------------- % \begin{funcdesc}{name}{args} \newcommand{\funcline}[2]{% - \funclineni{#1}{#2}} + \py@sigline{\bfcode{#1}}{#2}} \newenvironment{funcdesc}[2]{ \begin{fulllineitems} \funcline{#1}{#2} }{\end{fulllineitems}} -% similar to {funcdesc}, but doesn't add to the index -\newcommand{\funclineni}[2]{% - \py@sigline{\bfcode{#1}}{#2}} -\newenvironment{funcdescni}[2]{ - \begin{fulllineitems} - \funclineni{#1}{#2} -}{\end{fulllineitems}} - % classes ---------------------------------------------------------------- % \begin{classdesc}{name}{constructor args} \newcommand{\classline}[2]{ @@ -439,23 +431,6 @@ \classline{#1}{#2} }{\end{fulllineitems}} -\newcommand{\classlineni}[2]{ - \py@sigline{\strong{class }\bfcode{#1}}{#2}} -\newenvironment{classdescni}[2]{ - % Using \renewcommand doesn't work for this, for unknown reasons: - \global\def\py@thisclass{#1} - \begin{fulllineitems} - \classlineni{#1}{#2} -}{\end{fulllineitems}} - -% \begin{classdesc*}{name} -\newenvironment{classdesc*}[1]{ - % Using \renewcommand doesn't work for this, for unknown reasons: - \global\def\py@thisclass{#1} - \begin{fulllineitems} - \item[\strong{class }\code{\bfcode{#1}}] -}{\end{fulllineitems}} - % \begin{excclassdesc}{name}{constructor args} % but indexes as an exception \newenvironment{excclassdesc}[2]{ @@ -474,8 +449,7 @@ % object method ---------------------------------------------------------- % \begin{methoddesc}[classname]{methodname}{args} \newcommand{\methodline}[3][\@undefined]{ - \methodlineni{#2}{#3} -} + \py@sigline{\bfcode{#2}}{#3}} \newenvironment{methoddesc}[3][\@undefined]{ \begin{fulllineitems} \ifx\@undefined#1\relax @@ -486,20 +460,10 @@ \fi }{\end{fulllineitems}} -% similar to {methoddesc}, but doesn't add to the index -% (never actually uses the optional argument) -\newcommand{\methodlineni}[3][\py@classbadkey]{% - \py@sigline{\bfcode{#2}}{#3}} -\newenvironment{methoddescni}[3][\py@classbadkey]{ - \begin{fulllineitems} - \methodlineni{#2}{#3} -}{\end{fulllineitems}} - % static method ---------------------------------------------------------- % \begin{staticmethoddesc}[classname]{methodname}{args} \newcommand{\staticmethodline}[3][\@undefined]{ - \staticmethodlineni{#2}{#3} -} + \py@sigline{static \bfcode{#2}}{#3}} \newenvironment{staticmethoddesc}[3][\@undefined]{ \begin{fulllineitems} \ifx\@undefined#1\relax @@ -510,22 +474,13 @@ \fi }{\end{fulllineitems}} -% similar to {staticmethoddesc}, but doesn't add to the index -% (never actually uses the optional argument) -\newcommand{\staticmethodlineni}[3][\py@classbadkey]{% - \py@sigline{static \bfcode{#2}}{#3}} -\newenvironment{staticmethoddescni}[3][\py@classbadkey]{ - \begin{fulllineitems} - \staticmethodlineni{#2}{#3} -}{\end{fulllineitems}} - % object data attribute -------------------------------------------------- % \begin{memberdesc}[classname]{membername} \newcommand{\memberline}[2][\py@classbadkey]{% \ifx\@undefined#1\relax - \memberlineni{#2} + \item[\bfcode{#2}] \else - \memberlineni{#2} + \item[\bfcode{#2}] \fi } \newenvironment{memberdesc}[2][\py@classbadkey]{ @@ -538,14 +493,6 @@ \fi }{\end{fulllineitems}} -% similar to {memberdesc}, but doesn't add to the index -% (never actually uses the optional argument) -\newcommand{\memberlineni}[2][\py@classbadkey]{\item[\bfcode{#2}]} -\newenvironment{memberdescni}[2][\py@classbadkey]{ - \begin{fulllineitems} - \memberlineni{#2} -}{\end{fulllineitems}} - % For exceptions: -------------------------------------------------------- % \begin{excdesc}{name} % -- for constructor information, use excclassdesc instead @@ -557,19 +504,12 @@ % Module data or constants: ---------------------------------------------- % \begin{datadesc}{name} \newcommand{\dataline}[1]{% - \datalineni{#1}} + \item[\bfcode{#1}]\nopagebreak} \newenvironment{datadesc}[1]{ \begin{fulllineitems} \dataline{#1} }{\end{fulllineitems}} -% similar to {datadesc}, but doesn't add to the index -\newcommand{\datalineni}[1]{\item[\bfcode{#1}]\nopagebreak} -\newenvironment{datadescni}[1]{ - \begin{fulllineitems} - \datalineni{#1} -}{\end{fulllineitems}} - % bytecode instruction --------------------------------------------------- % \begin{opcodedesc}{name}{var} % -- {var} may be {}