Thread: [Epydoc-commits] SF.net SVN: epydoc: [1738] trunk/epydoc/src/epydoc/docwriter/latex_sty.py
Brought to you by:
edloper
From: <ed...@us...> - 2008-02-23 01:59:02
|
Revision: 1738 http://epydoc.svn.sourceforge.net/epydoc/?rev=1738&view=rev Author: edloper Date: 2008-02-22 17:59:00 -0800 (Fri, 22 Feb 2008) Log Message: ----------- - Fixed a bug in EpydocClassList Modified Paths: -------------- trunk/epydoc/src/epydoc/docwriter/latex_sty.py Modified: trunk/epydoc/src/epydoc/docwriter/latex_sty.py =================================================================== --- trunk/epydoc/src/epydoc/docwriter/latex_sty.py 2008-02-23 01:07:47 UTC (rev 1737) +++ trunk/epydoc/src/epydoc/docwriter/latex_sty.py 2008-02-23 01:59:00 UTC (rev 1738) @@ -252,7 +252,7 @@ % This list environment is used to list the classes that are defined % by a module. \newenvironment{EpydocClassList}{% - \newcommand{\EpydocGroup}[1]{\item[##1] \ + \renewcommand{\EpydocGroup}[1]{\item[##1] \ } \begin{itemize} \renewcommand{\makelabel}[1]{\textbf{##1:}} @@ -268,7 +268,7 @@ % % - The function's signature: an EpydocFunctionSignature environment % specifying the signature for the function. - +% % - The function's description (from the docstring) % % - The function's parameters: An EpydocFunctionParameters list This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <ed...@us...> - 2008-02-23 02:02:59
|
Revision: 1740 http://epydoc.svn.sourceforge.net/epydoc/?rev=1740&view=rev Author: edloper Date: 2008-02-22 18:02:57 -0800 (Fri, 22 Feb 2008) Log Message: ----------- - Fixed misspelling Modified Paths: -------------- trunk/epydoc/src/epydoc/docwriter/latex_sty.py Modified: trunk/epydoc/src/epydoc/docwriter/latex_sty.py =================================================================== --- trunk/epydoc/src/epydoc/docwriter/latex_sty.py 2008-02-23 01:59:26 UTC (rev 1739) +++ trunk/epydoc/src/epydoc/docwriter/latex_sty.py 2008-02-23 02:02:57 UTC (rev 1740) @@ -12,7 +12,7 @@ #: A disclaimer that is appended to the bottom of the BASE and #: BOXES stylesheets. NIST_DISCLAIMER = r""" -% This style file is a derivite work, based on a public domain style +% This style file is a derivative work, based on a public domain style % file that was originally developed at the National Institute of % Standards and Technology by employees of the Federal Government in the % course of their official duties. NIST assumes no responsibility This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <ed...@us...> - 2008-02-23 16:12:45
|
Revision: 1751 http://epydoc.svn.sourceforge.net/epydoc/?rev=1751&view=rev Author: edloper Date: 2008-02-23 08:12:43 -0800 (Sat, 23 Feb 2008) Log Message: ----------- - Fixed latex bug in SHADED stylesheet Modified Paths: -------------- trunk/epydoc/src/epydoc/docwriter/latex_sty.py Modified: trunk/epydoc/src/epydoc/docwriter/latex_sty.py =================================================================== --- trunk/epydoc/src/epydoc/docwriter/latex_sty.py 2008-02-23 16:09:47 UTC (rev 1750) +++ trunk/epydoc/src/epydoc/docwriter/latex_sty.py 2008-02-23 16:12:43 UTC (rev 1751) @@ -1023,16 +1023,14 @@ \begin{@EpydocGeneralList}} {\end{@EpydocGeneralList}} -\renewenvironment{EpydocGroup}[1][]{% - \ifthenelse{\equal{#1}{}}{}{ +\renewcommand{\EpydocGroup}[1]{ - \begin{cminipage}[gray80]{\dimexpr \linewidth-2\fboxsep \relax} - {\Large\bf\center #1\\} - \end{cminipage} - - }} - {} + \begin{cminipage}[gray80]{\dimexpr \linewidth-2\fboxsep \relax} + {\Large\bf\center #1\\} + \end{cminipage} + } + % This is just like the default definitions, except that we use % \raggedright, and dedent by \EpydocSectionHeaderDedent \newlength{\EpydocSectionHeaderDedent} This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <ed...@us...> - 2008-02-23 19:33:40
|
Revision: 1760 http://epydoc.svn.sourceforge.net/epydoc/?rev=1760&view=rev Author: edloper Date: 2008-02-23 11:33:37 -0800 (Sat, 23 Feb 2008) Log Message: ----------- - Fixed bug in base style's def of EpydocProperty command Modified Paths: -------------- trunk/epydoc/src/epydoc/docwriter/latex_sty.py Modified: trunk/epydoc/src/epydoc/docwriter/latex_sty.py =================================================================== --- trunk/epydoc/src/epydoc/docwriter/latex_sty.py 2008-02-23 19:32:13 UTC (rev 1759) +++ trunk/epydoc/src/epydoc/docwriter/latex_sty.py 2008-02-23 19:33:37 UTC (rev 1760) @@ -487,25 +487,25 @@ \gdef\@EpydocPropertyGet{##4}% \gdef\@EpydocPropertySet{##5}% \gdef\@EpydocPropertyDel{##6}% - {\Large\raggedright\@EpydocVariableName} + {\Large\raggedright\@EpydocPropertyName} \begin{quote} \setlength{\parskip}{\EpydocParskip}% - \ifx\@EpydocVariableDescription\empty\else + \ifx\@EpydocPropertyDescription\empty\else - \@EpydocVariableDescription\fi% - \ifx\@EpydocVariableType\empty\else + \@EpydocPropertyDescription\fi% + \ifx\@EpydocPropertyType\empty\else - \textbf{Type:} \@EpydocVariableType\fi% - \ifx\@EpydocVariableGet\empty + \textbf{Type:} \@EpydocPropertyType\fi% + \ifx\@EpydocPropertyGet\empty - \textbf{Get:} \texttt{\@EpydocVariableGet}\fi% - \ifx\@EpydocVariableSet\empty + \textbf{Get:} \texttt{\@EpydocPropertyGet}\fi% + \ifx\@EpydocPropertySet\empty - \textbf{Set:} \texttt{\@EpydocVariableSet}\fi% - \ifx\@EpydocVariableDel\empty + \textbf{Set:} \texttt{\@EpydocPropertySet}\fi% + \ifx\@EpydocPropertyDel\empty - \textbf{Delete:} \texttt{\@EpydocVariableDel}\fi% + \textbf{Delete:} \texttt{\@EpydocPropertyDel}\fi% \end{quote} }} {} This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <ed...@us...> - 2008-02-24 18:08:22
|
Revision: 1782 http://epydoc.svn.sourceforge.net/epydoc/?rev=1782&view=rev Author: edloper Date: 2008-02-24 10:08:21 -0800 (Sun, 24 Feb 2008) Log Message: ----------- - Removed some obsolete comments - Moved \RequirePackage for longtable to the 'boxed' stylesheet - Fixed horizontal spacing for var & property tables - var & property tables now use a double-thick outline (matching the outline used by function boxes) - increased size of heading text in var & property tables Modified Paths: -------------- trunk/epydoc/src/epydoc/docwriter/latex_sty.py Modified: trunk/epydoc/src/epydoc/docwriter/latex_sty.py =================================================================== --- trunk/epydoc/src/epydoc/docwriter/latex_sty.py 2008-02-24 16:56:35 UTC (rev 1781) +++ trunk/epydoc/src/epydoc/docwriter/latex_sty.py 2008-02-24 18:08:21 UTC (rev 1782) @@ -47,7 +47,7 @@ % Basic Package Requirements \RequirePackage{alltt, boxedminipage} -\RequirePackage{multirow, longtable, amssymb} +\RequirePackage{multirow, amssymb} \RequirePackage[headings]{fullpage} \RequirePackage[usenames]{color} \RequirePackage{ifthen} @@ -429,10 +429,6 @@ % % If any of these arguments is not available, then the empty % string will be used. -% -% See EpydocGeneralList, above, for info about the commands -% \EpydocInternalHeader and \EpydocInheritanceItemList, which -% may be used inside the EpydocVariableList environment. \newenvironment{EpydocVariableList}{% \newcommand{\EpydocVariable}[4]{% \gdef\@EpydocVariableName{##1}% @@ -484,13 +480,6 @@ % % If any of these arguments is not available, then the empty % string will be used. -% -% See EpydocGeneralList, above, for info about the commands -% \EpydocInternalHeader and \EpydocInheritanceItemList, which -% may be used inside the EpydocVariableList environment. -% -% Implementation node: \@EpydocSeparator evaluates to nothing on -% the first use, and to a paragraph break on subsequent uses. \newenvironment{EpydocPropertyList}{% \newcommand{\EpydocProperty}[6]{% \gdef\@EpydocPropertyName{##1}% @@ -623,10 +612,16 @@ \ProcessOptions\relax \RequirePackage{epydoc-base} +\RequirePackage{longtable} % Double the standard size boxedminipage outlines. \setlength{\fboxrule}{2\fboxrule} +% Set the width of the variable name cells in the variable & property +% tables. +\newlength{\EpydocVariableWidth} +\setlength{\EpydocVariableWidth}{.3\textwidth} + % ====================================================================== % Function Lists @@ -707,22 +702,34 @@ % \EpydocInheritanceList commands to add a row to the table. \newenvironment{@EpydocGeneralList}{% \renewcommand{\EpydocGroup}[1]{% - \multicolumn{2}{|l|}{\textbf{##1}} \\ - \hline}% + \multicolumn{2}{@{\vrule width \fboxrule \hspace \tabcolsep}l + @{\hspace \tabcolsep \vrule width \fboxrule}} + {\textbf{\textit{##1}}} \\ + \hline}% \renewcommand{\EpydocInheritanceList}[2]{% - \multicolumn{2}{|p{\dimexpr \textwidth -4\tabcolsep-3\arrayrulewidth}|}{% - \raggedright\textbf{Inherited from {##1}:\\ - ##2}} \\ - \hline} - \begin{longtable}{|p{.30\textwidth}|p{.62\textwidth}|} + \multicolumn{2}{@{\vrule width \fboxrule \hspace \tabcolsep} + p{\dimexpr \textwidth -4\tabcolsep-7pt} + @{\hspace \tabcolsep \vrule width \fboxrule}} + {\raggedright\textbf{Inherited from {##1}:\\##2}} \\ + \hline}% + \setlength{\doublerulesep}{0pt} + \begin{longtable}[l]{@{\vrule width \fboxrule \hspace \tabcolsep} + p{\EpydocVariableWidth}| + p{\dimexpr \textwidth% + -4\tabcolsep-7pt + -\EpydocVariableWidth \relax} + @{\hspace \tabcolsep \vrule width \fboxrule}} % Set up the headers & footer (this makes the table span % multiple pages in a happy way). - \hline - \centering \textbf{Name} & \centering \textbf{Description} + \hline \hline \rule{0pt}{\baselineskip} + \centering \Large \textbf{Name} & + \centering \Large \textbf{Description} \tabularnewline - \hline - \endhead\hline\multicolumn{2}{r}{% - \small\textit{continued on next page}}\\\endfoot\hline + \hline \hline + \endhead% + \hline\hline\multicolumn{2}{r}{% + \small\textit{continued on next page}}\\\endfoot% + \hline\hline \endlastfoot} {\end{longtable}} @@ -755,8 +762,9 @@ \fi% \fi% \tabularnewline - \hline} - \begin{@EpydocGeneralList}} + \hline}% + \begin{@EpydocGeneralList}% + } {\end{@EpydocGeneralList}} % By default, EpydocClassVariableList & EpydocInstanceVariableList are @@ -765,6 +773,8 @@ % ====================================================================== % Property Lists +% Implementation node: \@EpydocSeparator evaluates to nothing on +% the first use, and to a paragraph break on subsequent uses. \renewenvironment{EpydocPropertyList}{% \def\@EpydocSeparator{% \aftergroup\def\aftergroup\@EpydocSeparator\aftergroup{% This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <ed...@us...> - 2008-02-24 18:27:02
|
Revision: 1783 http://epydoc.svn.sourceforge.net/epydoc/?rev=1783&view=rev Author: edloper Date: 2008-02-24 10:27:00 -0800 (Sun, 24 Feb 2008) Log Message: ----------- - Replaced blank lines with explicit \par commands Modified Paths: -------------- trunk/epydoc/src/epydoc/docwriter/latex_sty.py Modified: trunk/epydoc/src/epydoc/docwriter/latex_sty.py =================================================================== --- trunk/epydoc/src/epydoc/docwriter/latex_sty.py 2008-02-24 18:08:21 UTC (rev 1782) +++ trunk/epydoc/src/epydoc/docwriter/latex_sty.py 2008-02-24 18:27:00 UTC (rev 1783) @@ -219,12 +219,8 @@ % the default definition, but several of the Epydoc*List environments % use \renewcommand to provide definitions that are appropriate for the % style of that environment. -\newcommand{\EpydocGroup}[1]{ +\newcommand{\EpydocGroup}[1]{\par{\large #1}\par} - {\large #1} - - } - % ====================================================================== % Inheritance @@ -235,7 +231,7 @@ % use \renewcommand to provide definitions that are appropriate for the % style of that environment. \newcommand{\EpydocInheritanceList}[2]{% - \textbf{Inherited from {#1}:} #2} + \textbf{Inherited from {#1}:} #2\par} % ====================================================================== % Submodule List @@ -313,31 +309,23 @@ \gdef\@EpydocFunctionRaises{##6}% \gdef\@EpydocFunctionOverrides{##7}% \gdef\@EpydocFunctionMetadata{##8}% - {\Large\raggedright\@EpydocFunctionSignature} - + {\Large\raggedright\@EpydocFunctionSignature}\par \begin{quote}% \setlength{\parskip}{\EpydocParskip}% \ifx\@EpydocFunctionDescription\empty\else - - \@EpydocFunctionDescription\fi% + \par\@EpydocFunctionDescription\fi% \ifx\@EpydocFunctionParameters\empty\else - - \@EpydocFunctionParameters\fi% + \par\@EpydocFunctionParameters\fi% \ifx\@EpydocFunctionReturnDescr\empty - - \@EpydocFunctionReturnDescr\fi% + \par\@EpydocFunctionReturnDescr\fi% \ifx\@EpydocFunctionReturnType\empty - - \@EpydocFunctionReturnType\fi% + \par\@EpydocFunctionReturnType\fi% \ifx\@EpydocFunctionRaises\empty\else - - \@EpydocFunctionRaises\fi% + \par\@EpydocFunctionRaises\fi% \ifx\@EpydocFunctionOverrides\empty\else - - \@EpydocFunctionOverrides\fi% + \par\@EpydocFunctionOverrides\fi% \ifx\@EpydocFunctionMetadata\empty\else - - \@EpydocFunctionMetadata\fi% + \par\@EpydocFunctionMetadata\fi% \end{quote} }} @@ -406,10 +394,8 @@ % method, to display the name of the overridden method. \newcommand{\EpydocFunctionOverrides}[2][0]{% \textbf{Overrides:} #2 % - \ifthenelse{#1=1}{\textit{(inherited documentation)}{}} + \ifthenelse{#1=1}{\textit{(inherited documentation)}{}}\par} - } - % ====================================================================== % Variable Lists % @@ -435,19 +421,15 @@ \gdef\@EpydocVariableDescription{##2}% \gdef\@EpydocVariableType{##3}% \gdef\@EpydocVariableValue{##4}% - {\Large\raggedright\@EpydocVariableName} - + {\Large\raggedright\@EpydocVariableName}\par \begin{quote} \setlength{\parskip}{\EpydocParskip}% \ifx\@EpydocVariableDescription\empty\else - - \@EpydocVariableDescription\fi% + \par\@EpydocVariableDescription\fi% \ifx\@EpydocVariableType\empty\else - - \textbf{Type:} \@EpydocVariableType\fi% + \par\textbf{Type:} \@EpydocVariableType\fi% \ifx\@EpydocVariableValue\empty - - \textbf{Value:} \texttt{\@EpydocVariableValue}\fi% + \par\textbf{Value:} \texttt{\@EpydocVariableValue}\fi% \end{quote} }} {} @@ -488,25 +470,19 @@ \gdef\@EpydocPropertyGet{##4}% \gdef\@EpydocPropertySet{##5}% \gdef\@EpydocPropertyDel{##6}% - {\Large\raggedright\@EpydocPropertyName} - + {\Large\raggedright\@EpydocPropertyName}\par \begin{quote} \setlength{\parskip}{\EpydocParskip}% \ifx\@EpydocPropertyDescription\empty\else - - \@EpydocPropertyDescription\fi% + \par\@EpydocPropertyDescription\fi% \ifx\@EpydocPropertyType\empty\else - - \textbf{Type:} \@EpydocPropertyType\fi% + \par\textbf{Type:} \@EpydocPropertyType\fi% \ifx\@EpydocPropertyGet\empty - - \textbf{Get:} \texttt{\@EpydocPropertyGet}\fi% + \par\textbf{Get:} \texttt{\@EpydocPropertyGet}\fi% \ifx\@EpydocPropertySet\empty - - \textbf{Set:} \texttt{\@EpydocPropertySet}\fi% + \par\textbf{Set:} \texttt{\@EpydocPropertySet}\fi% \ifx\@EpydocPropertyDel\empty - - \textbf{Delete:} \texttt{\@EpydocPropertyDel}\fi% + \par\textbf{Delete:} \texttt{\@EpydocPropertyDel}\fi% \end{quote} }} {} @@ -646,8 +622,7 @@ \gdef\@EpydocFunctionMetadata{##8}% \begin{boxedminipage}{\dimexpr \textwidth-2\fboxsep \relax} {\Large \@EpydocFunctionSignature} - \setlength{\parskip}{\EpydocParskip}% - + \setlength{\parskip}{\EpydocParskip}\par \ifx\@EpydocFunctionDescription\empty\else% {\@EpydocSeparator}% \@EpydocFunctionDescription % @@ -747,15 +722,11 @@ \@EpydocVariableDescription % \ifx\@EpydocVariableValue\empty\relax% \ifx\@EpydocVariableType\empty\else% - \ifx\@EpydocVariableDescription\empty\else - - \fi% + \ifx\@EpydocVariableDescription\empty\else\par\fi% \textit{(type=\texttt{\@EpydocVariableType})}% \fi% \else\relax% - \ifx\@EpydocVariableDescription\empty\else - - \fi% + \ifx\@EpydocVariableDescription\empty\else\par\fi% \textbf{Value:} \texttt{\@EpydocVariableValue}% \ifx\@EpydocVariableType\empty\else% \textit{(type=\texttt{\@EpydocVariableType})}% @@ -894,9 +865,7 @@ \end{cminipage}% \if@EpydocFunctionDetails \begin{cminipage}{\dimexpr 0.95\linewidth-2\fboxsep \relax}% - \setlength{\parskip}{\EpydocParskip}% - \setlength{\parskip}{\EpydocParskip}% - + \setlength{\parskip}{\EpydocParskip} \ifx\@EpydocFunctionDescription\empty\else% \@EpydocFunctionDescription % \fi% @@ -930,26 +899,19 @@ \fi% \end{cminipage}% \fi% - \end{minipage} - - }} + \end{minipage}\par}} {} \newenvironment{@EpydocGeneralList}{% - \renewcommand{\EpydocGroup}[1]{ - + \renewcommand{\EpydocGroup}[1]{\par \begin{cminipage}[gray80]{\dimexpr \linewidth-2\fboxsep \relax} {\Large\bf\center ##1\\} - \end{cminipage} - - }% - \renewcommand{\EpydocInheritanceList}[2]{% + \end{cminipage}\par} + \renewcommand{\EpydocInheritanceList}[2]{\par \begin{cminipage}[gray95]{\dimexpr \textwidth-2\fboxsep \relax} Inherited from {##1}: ##2% - \end{cminipage}% + \end{cminipage}\par}}{} - }}{} - \newlength{\EpydocValueWidth} \renewenvironment{EpydocVariableList}{% @@ -970,27 +932,24 @@ \ifx\@EpydocVariableValue\empty\else \@EpydocVariableDetailstrue\fi% \if@EpydocVariableDetails \begin{cminipage}{\dimexpr 0.95\linewidth-2\fboxsep \relax} + \setlength{\parskip}{\EpydocParskip} \ifx\@EpydocVariableDescription\empty\else - - \@EpydocVariableDescription + \par\@EpydocVariableDescription \fi% \ifx\@EpydocVariableType\empty\else - - \textbf{Type:} \texttt{\@EpydocVariableType} + \par\textbf{Type:} \texttt{\@EpydocVariableType} \fi% \ifx\@EpydocVariableValue\empty\else - - \settowidth{\EpydocValueWidth}{Value:w}% + \par\settowidth{\EpydocValueWidth}{Value:w}% Value: - \begin{cminipage}[gray85]{\dimexpr \textwidth-2\fboxsep-\EpydocValueWidth \relax} + \begin{cminipage}[gray85]{\dimexpr \textwidth-2\fboxsep- + \EpydocValueWidth \relax} \texttt{\@EpydocVariableValue} \end{cminipage}% \fi% \end{cminipage}% \fi% - \end{minipage}% - - } + \end{minipage}\par} \begin{@EpydocGeneralList}} {\end{@EpydocGeneralList}} @@ -1016,42 +975,33 @@ \ifx\@EpydocPropertyDel\empty\else \@EpydocPropertyDetailstrue\fi% \if@EpydocPropertyDetails \begin{cminipage}{\dimexpr 0.95\linewidth-2\fboxsep \relax} + \setlength{\parskip}{\EpydocParskip} \ifx\@EpydocPropertyDescription\empty\else% - - \@EpydocPropertyDescription + \par\@EpydocPropertyDescription \fi% \ifx\@EpydocPropertyType\empty\else - - \textbf{Type:} \@EpydocPropertyType + \par\textbf{Type:} \@EpydocPropertyType \fi% \ifx\@EpydocPropertyGet\empty\else - - \textbf{Get:} \@EpydocPropertyGet% + \par\textbf{Get:} \@EpydocPropertyGet% \fi% \ifx\@EpydocPropertySet\empty\else - - \textbf{Set:} \@EpydocPropertySet% + \par\textbf{Set:} \@EpydocPropertySet% \fi% \ifx\@EpydocPropertyDel\empty\else - - \textbf{Delete:} \@EpydocPropertyDel% + \par\textbf{Delete:} \@EpydocPropertyDel% \fi% \end{cminipage}% \fi% - \end{minipage}% - - } + \end{minipage}\par} \begin{@EpydocGeneralList}} {\end{@EpydocGeneralList}} -\renewcommand{\EpydocGroup}[1]{ - +\renewcommand{\EpydocGroup}[1]{\par \begin{cminipage}[gray80]{\dimexpr \linewidth-2\fboxsep \relax} {\Large\bf\center #1\\} - \end{cminipage} + \end{cminipage}\par} - } - % This is just like the default definitions, except that we use % \raggedright, and dedent by \EpydocSectionHeaderDedent \newlength{\EpydocSectionHeaderDedent} This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <ed...@us...> - 2008-02-25 00:09:27
|
Revision: 1789 http://epydoc.svn.sourceforge.net/epydoc/?rev=1789&view=rev Author: edloper Date: 2008-02-24 16:09:24 -0800 (Sun, 24 Feb 2008) Log Message: ----------- - Added \raggedright to function signatures in shaded style Modified Paths: -------------- trunk/epydoc/src/epydoc/docwriter/latex_sty.py Modified: trunk/epydoc/src/epydoc/docwriter/latex_sty.py =================================================================== --- trunk/epydoc/src/epydoc/docwriter/latex_sty.py 2008-02-24 20:04:18 UTC (rev 1788) +++ trunk/epydoc/src/epydoc/docwriter/latex_sty.py 2008-02-25 00:09:24 UTC (rev 1789) @@ -309,7 +309,7 @@ \gdef\@EpydocFunctionRaises{##6}% \gdef\@EpydocFunctionOverrides{##7}% \gdef\@EpydocFunctionMetadata{##8}% - {\Large\raggedright\@EpydocFunctionSignature}\par + {\Large\raggedright\@EpydocFunctionSignature\par} \begin{quote}% \setlength{\parskip}{\EpydocParskip}% \ifx\@EpydocFunctionDescription\empty\else @@ -421,7 +421,7 @@ \gdef\@EpydocVariableDescription{##2}% \gdef\@EpydocVariableType{##3}% \gdef\@EpydocVariableValue{##4}% - {\Large\raggedright\@EpydocVariableName}\par + {\Large\raggedright\@EpydocVariableName\par} \begin{quote} \setlength{\parskip}{\EpydocParskip}% \ifx\@EpydocVariableDescription\empty\else @@ -470,7 +470,7 @@ \gdef\@EpydocPropertyGet{##4}% \gdef\@EpydocPropertySet{##5}% \gdef\@EpydocPropertyDel{##6}% - {\Large\raggedright\@EpydocPropertyName}\par + {\Large\raggedright\@EpydocPropertyName\par} \begin{quote} \setlength{\parskip}{\EpydocParskip}% \ifx\@EpydocPropertyDescription\empty\else @@ -621,8 +621,8 @@ \gdef\@EpydocFunctionOverrides{##7}% \gdef\@EpydocFunctionMetadata{##8}% \begin{boxedminipage}{\dimexpr \textwidth-2\fboxsep \relax} - {\Large \@EpydocFunctionSignature} - \setlength{\parskip}{\EpydocParskip}\par + {\Large\raggedright\@EpydocFunctionSignature\par} + \setlength{\parskip}{\EpydocParskip} \ifx\@EpydocFunctionDescription\empty\else% {\@EpydocSeparator}% \@EpydocFunctionDescription % @@ -661,9 +661,7 @@ {\@EpydocSeparator}% \@EpydocFunctionMetadata % \fi% - \end{boxedminipage} - - }} + \end{boxedminipage}\par}} {} % ====================================================================== @@ -717,7 +715,7 @@ \gdef\@EpydocVariableDescription{##2}% \gdef\@EpydocVariableType{##3}% \gdef\@EpydocVariableValue{##4}% - \raggedright \@EpydocVariableName & % + \raggedright\@EpydocVariableName & % \setlength{\parskip}{\EpydocParskip}\raggedright% \@EpydocVariableDescription % \ifx\@EpydocVariableValue\empty\relax% @@ -758,7 +756,7 @@ \gdef\@EpydocPropertyGet{##4}% \gdef\@EpydocPropertySet{##5}% \gdef\@EpydocPropertyDel{##6}% - \raggedright \@EpydocPropertyName & % + \raggedright\@EpydocPropertyName & % \setlength{\parskip}{\EpydocParskip}\raggedright% \ifx\@EpydocPropertyDescription\empty\else% {\@EpydocSeparator}% @@ -861,7 +859,7 @@ \begin{minipage}{\textwidth}% \raggedleft% \begin{cminipage}[gray95]{\dimexpr \textwidth-2\fboxsep \relax} - {\Large \@EpydocFunctionSignature} + \Large\raggedright\@EpydocFunctionSignature \end{cminipage}% \if@EpydocFunctionDetails \begin{cminipage}{\dimexpr 0.95\linewidth-2\fboxsep \relax}% This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <ed...@us...> - 2008-02-25 00:38:00
|
Revision: 1790 http://epydoc.svn.sourceforge.net/epydoc/?rev=1790&view=rev Author: edloper Date: 2008-02-24 16:37:58 -0800 (Sun, 24 Feb 2008) Log Message: ----------- - When wrapping function signatures, align the wrapped args with the function's open paren. Modified Paths: -------------- trunk/epydoc/src/epydoc/docwriter/latex_sty.py Modified: trunk/epydoc/src/epydoc/docwriter/latex_sty.py =================================================================== --- trunk/epydoc/src/epydoc/docwriter/latex_sty.py 2008-02-25 00:09:24 UTC (rev 1789) +++ trunk/epydoc/src/epydoc/docwriter/latex_sty.py 2008-02-25 00:37:58 UTC (rev 1790) @@ -357,8 +357,8 @@ \newcommand{\Param}[2][]{% \textit{##2}% \ifthenelse{\equal{##1}{}}{}{=\texttt{##1}}}% - \textbf{#1}(% - }{)} + \@hangfrom{\textbf{#1}(}% + }{)\par} % The EpydocFunctionParameters environment is used to display % descriptions for the parameters that a function can take. This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <ed...@us...> - 2008-03-05 18:40:36
|
Revision: 1808 http://epydoc.svn.sourceforge.net/epydoc/?rev=1808&view=rev Author: edloper Date: 2008-03-05 10:40:33 -0800 (Wed, 05 Mar 2008) Log Message: ----------- - Use \raggedright for the subclass list - Use utf8x encoding, instead of utf8 - \EpydocDottedName now expects its argument to use escaped characters (underscore in particular.) E.g., \EpydocDottedName{foo\_bar}. It no longer uses the latex url package. This makes it work better with the hyperref package. - Misc changes to show_latex_warnings(). Modified Paths: -------------- trunk/epydoc/src/epydoc/docwriter/latex_sty.py Modified: trunk/epydoc/src/epydoc/docwriter/latex_sty.py =================================================================== --- trunk/epydoc/src/epydoc/docwriter/latex_sty.py 2008-03-04 02:32:58 UTC (rev 1807) +++ trunk/epydoc/src/epydoc/docwriter/latex_sty.py 2008-03-05 18:40:33 UTC (rev 1808) @@ -75,7 +75,6 @@ \RequirePackage[headings]{fullpage} \RequirePackage[usenames]{color} \RequirePackage{graphicx} -\RequirePackage{url} \@ifclassloaded{memoir}{% \RequirePackage[other,notbib]{tocbibind} @@ -107,6 +106,9 @@ % ====================================================================== % General Formatting +% Setting this will make us less likely to get overfull hboxes: +%\setlength{\emergencystretch}{1in} + % Separate paragraphs by a blank line (do not indent them). We define % a new length variable. \EpydocParskip, for the paragraph-skip length. % This needs to be assigned to \parskip here as well as inside several @@ -566,23 +568,28 @@ % This section defines the EpydocDottedName command, which is used to % display the names of Python objects. -% The \EpydocDottedName command is used to escape dotted names. In -% particular, it escapes all characters except '#', '%', and newlines, -% and allows non-hyphenated wrapping at '.' separator characters. -% [xx] this generates a warning for names containing _ -- we need -% to somehow strip that out of the second argument. -\newcommand\EpydocDottedName[1]{% - \texorpdfstring{\protect\Epydoc@DottedName{#1}}{#1}} +% The \EpydocDottedName command adds a possible break-point after every +% period in the given string. It no longer escapes characters such as +% underscore, since this interfered with the hyperref package; instead, +% epydoc is responsible for escaping them. E.g., correct usage for a +% name with an underscore is \EpydocDottedName{some\_name}. +\newcommand\EpydocDottedName[1]{ + \Epydoc@DottedName #1.@} -\DeclareUrlCommand\Epydoc@DottedName{% - \urlstyle{rm}% - \def\UrlBigBreaks{\do\.}% - % We should never see most of these chars in a name, but handle - % them if they happen to show up (eg script names) - \def\UrlOrds{\do\@\do\#\do\%\do\^\do\&\do\(\do\)\do\-\do\_% - \do\|\do\\\do\"\do\/\do\?\do\>\do\<\do\{\do\}% - \do\`\do\~} -} +% This helper function performs the work of \EpydocDottedName. It +% scans forward, looking for a period, and putting all text up to the +% period into #1. The single character after the period is put in +% #2. This function then checks if #2 is '@', indicating that we're +% done, or some other character, indicating that we should continue. +% Note that \ifx tests character codes; and that when '@' appears +% in user code, it gets the character code 'other', but when it +% appears here, it gets the character code 'letter'. +\def\Epydoc@DottedName#1.#2{% + \ifx#2@\relax #1\else + #1\discretionary{.}{}{.}% + \expandafter\expandafter\expandafter\Epydoc@DottedName + \expandafter #2\fi% + } """+NIST_DISCLAIMER ###################################################################### This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |