Changeset 2763 for trunk

Show
Ignore:
Timestamp:
10/22/2008 10:59:53 PM (3 months ago)
Author:
guyer
Message:

merged source:branches/epydoc-3@2762 to source:trunk@2762

Location:
trunk
Files:
2 removed
9 modified
1 copied

Legend:

Unmodified
Added
Removed

  • trunk/FiPy.egg-info/SOURCES.txt

    r2762 r2763  
    2424documentation/figures/NIST_right2line.pdf 
    2525documentation/logo/logo.tex 
     26documentation/manual/docutils-emulation.sty 
    2627documentation/manual/epydoc.sty 
    2728documentation/manual/faq.tex 
    … …  
    277278fipy/boundaryConditions/test.py 
    278279fipy/meshes/__init__.py 
    279 fipy/meshes/adaptiveMesh.py 
    280280fipy/meshes/cylindricalGrid1D.py 
    281281fipy/meshes/cylindricalGrid2D.py 
    … …  
    501501utils/includedHTMLWriter.py 
    502502utils/includedLaTeXWriter.py 
    503 utils/epydoc/__init__.py 
    504 utils/epydoc/checker.py 
    505 utils/epydoc/cli.py 
    506 utils/epydoc/colorize.py 
    507 utils/epydoc/css.py 
    508 utils/epydoc/driver.py 
    509 utils/epydoc/foog.py 
    510 utils/epydoc/gui.py 
    511 utils/epydoc/help.py 
    512 utils/epydoc/html.py 
    513 utils/epydoc/imports.py 
    514 utils/epydoc/latex.py 
    515 utils/epydoc/man.py 
    516 utils/epydoc/objdoc.py 
    517 utils/epydoc/uid.py 
    518 utils/epydoc/markup/.cvsignore 
    519 utils/epydoc/markup/__init__.py 
    520 utils/epydoc/markup/epytext.py 
    521 utils/epydoc/markup/javadoc.py 
    522 utils/epydoc/markup/plaintext.py 
    523 utils/epydoc/markup/restructuredtext.py 
    524 utils/epydoc/test/.cvsignore 
    525 utils/epydoc/test/__init__.py 
    526 utils/epydoc/test/epytext.py 
     503utils/epydoc/Makefile 
     504utils/epydoc/doc/.cvsignore 
     505utils/epydoc/doc/configfile.html 
     506utils/epydoc/doc/custom.css 
     507utils/epydoc/doc/docstrings.html 
     508utils/epydoc/doc/docutils.css 
     509utils/epydoc/doc/epydoc-slides.pdf 
     510utils/epydoc/doc/epydoc-slides.ppt 
     511utils/epydoc/doc/epydoc.css 
     512utils/epydoc/doc/epydoc_gui.png 
     513utils/epydoc/doc/epydoc_guiconfig.png 
     514utils/epydoc/doc/epytext.html 
     515utils/epydoc/doc/epytext_example.py 
     516utils/epydoc/doc/epytextintro.html 
     517utils/epydoc/doc/faq.html 
     518utils/epydoc/doc/fields.html 
     519utils/epydoc/doc/future.html 
     520utils/epydoc/doc/history.html 
     521utils/epydoc/doc/home.thumbnail.png 
     522utils/epydoc/doc/index.html 
     523utils/epydoc/doc/index.thumbnail.png 
     524utils/epydoc/doc/inh_example.py 
     525utils/epydoc/doc/installing.html 
     526utils/epydoc/doc/license.html 
     527utils/epydoc/doc/manual-docstring.txt 
     528utils/epydoc/doc/manual-epytext.txt 
     529utils/epydoc/doc/manual-fields.txt 
     530utils/epydoc/doc/manual-install.txt 
     531utils/epydoc/doc/manual-othermarkup.txt 
     532utils/epydoc/doc/manual-reference.txt 
     533utils/epydoc/doc/manual-usage.txt 
     534utils/epydoc/doc/manual.txt 
     535utils/epydoc/doc/othermarkup.html 
     536utils/epydoc/doc/pycon-epydoc.html 
     537utils/epydoc/doc/pycon-epydoc.pdf 
     538utils/epydoc/doc/pycon-epydoc.ps 
     539utils/epydoc/doc/pysrc.thumbnail.png 
     540utils/epydoc/doc/relatedprojects.html 
     541utils/epydoc/doc/rst-template.txt 
     542utils/epydoc/doc/rst-template2.txt 
     543utils/epydoc/doc/sflogo.png 
     544utils/epydoc/doc/stylesheet.html 
     545utils/epydoc/doc/uml.thumbnail.png 
     546utils/epydoc/doc/using.html 
     547utils/epydoc/doc/whatsnew.html 
     548utils/epydoc/doc/doctest/index.html 
     549utils/epydoc/man/epydoc.1 
     550utils/epydoc/man/epydocgui.1 
     551utils/epydoc/src/LICENSE.txt 
     552utils/epydoc/src/MANIFEST.in 
     553utils/epydoc/src/Makefile 
     554utils/epydoc/src/README.txt 
     555utils/epydoc/src/setup.py 
     556utils/epydoc/src/epydoc/__init__.py 
     557utils/epydoc/src/epydoc/apidoc.py 
     558utils/epydoc/src/epydoc/checker.py 
     559utils/epydoc/src/epydoc/cli.py 
     560utils/epydoc/src/epydoc/compat.py 
     561utils/epydoc/src/epydoc/docbuilder.py 
     562utils/epydoc/src/epydoc/docintrospecter.py 
     563utils/epydoc/src/epydoc/docparser.py 
     564utils/epydoc/src/epydoc/docstringparser.py 
     565utils/epydoc/src/epydoc/gui.py 
     566utils/epydoc/src/epydoc/log.py 
     567utils/epydoc/src/epydoc/util.py 
     568utils/epydoc/src/epydoc/docwriter/__init__.py 
     569utils/epydoc/src/epydoc/docwriter/dotgraph.py 
     570utils/epydoc/src/epydoc/docwriter/html.py 
     571utils/epydoc/src/epydoc/docwriter/html_colorize.py 
     572utils/epydoc/src/epydoc/docwriter/html_css.py 
     573utils/epydoc/src/epydoc/docwriter/html_help.py 
     574utils/epydoc/src/epydoc/docwriter/latex.py 
     575utils/epydoc/src/epydoc/docwriter/plaintext.py 
     576utils/epydoc/src/epydoc/docwriter/xlink.py 
     577utils/epydoc/src/epydoc/docwriter/latexstyles/epydoc-default.sty 
     578utils/epydoc/src/epydoc/markup/__init__.py 
     579utils/epydoc/src/epydoc/markup/doctest.py 
     580utils/epydoc/src/epydoc/markup/epytext.py 
     581utils/epydoc/src/epydoc/markup/javadoc.py 
     582utils/epydoc/src/epydoc/markup/plaintext.py 
     583utils/epydoc/src/epydoc/markup/pyval_repr.py 
     584utils/epydoc/src/epydoc/markup/restructuredtext.py 
     585utils/epydoc/src/epydoc/test/__init__.py 
     586utils/epydoc/src/epydoc/test/apidoc.doctest 
     587utils/epydoc/src/epydoc/test/docbuilder.doctest 
     588utils/epydoc/src/epydoc/test/docintrospecter.doctest 
     589utils/epydoc/src/epydoc/test/docparser.doctest 
     590utils/epydoc/src/epydoc/test/encoding.doctest 
     591utils/epydoc/src/epydoc/test/epytext.doctest 
     592utils/epydoc/src/epydoc/test/javadoc.doctest 
     593utils/epydoc/src/epydoc/test/plaintext.doctest 
     594utils/epydoc/src/epydoc/test/pyval_repr.doctest 
     595utils/epydoc/src/epydoc/test/restructuredtext.doctest 
     596utils/epydoc/src/epydoc/test/util.py 
     597utils/epydoc/src/epydoc/test/zope2.doctest 
     598utils/epydoc/src/epydoc/test/zope3.doctest 
     599utils/epydoc/src/scripts/.cvsignore 
     600utils/epydoc/src/scripts/apirst2html.py 
     601utils/epydoc/src/scripts/epydoc 
     602utils/epydoc/src/scripts/epydoc.py 
     603utils/epydoc/src/scripts/epydoc.pyw 
     604utils/epydoc/src/scripts/epydocgui 
     605utils/epydoc/src/tools/mkdispatch.py 
     606utils/epydoc/src/tools/rst2html.py 

  • trunk/documentation/manual/epydoc.sty

    r1954 r2763  
    1515 
    1616% \RequirePackage{alltt, parskip, boxedminipage}  
    17 \RequirePackage{alltt, boxedminipage}  
    18 \RequirePackage{multirow, longtable, amssymb} 
    19  
    20 % \RequirePackage{fullpage} 
    21 \RequirePackage[headings]{fullpage} 
    22  
    23 \ifthenelse{\boolean{@dohyper}}{% 
    24     \RequirePackage[usenames]{color} 
    25     \definecolor{darkblue}{rgb}{0,0.05,0.35} 
    26 %     \RequirePackage[dvips, pagebackref, bookmarks=true, bookmarksopen=false, pdfpagemode=UseOutlines, colorlinks=true, linkcolor=black, anchorcolor=black, citecolor=black, filecolor=black, menucolor=black, pagecolor=black, urlcolor=darkblue]{hyperref} 
    27     \RequirePackage[urlcolor=blue,linkcolor=blue,bookmarksopen,bookmarksopenlevel=2,pdftex,pagebackref,pdftitle={FiPy}, pdfcreator={epydoc 2.1}, bookmarks=true, bookmarksopen=false, pdfpagemode=UseOutlines,colorlinks=true,plainpages=false,pdfpagelabels]{hyperref} 
    28 }{} 
     17% \RequirePackage{alltt, boxedminipage}  
     18% \RequirePackage{multirow, longtable, amssymb} 
     19\usepackage{alltt, parskip, fancyheadings, boxedminipage} 
     20\usepackage{makeidx, multirow, longtable, tocbibind, amssymb} 
     21 
     22\RequirePackage{fullpage} 
     23% \RequirePackage[headings]{fullpage} 
     24 
     25\RequirePackage[usenames]{color} 
     26 
     27\setlength{\headheight}{16pt} 
     28\setlength{\headsep}{24pt} 
     29\setlength{\topmargin}{-\headsep} 
     30 
     31% \ifthenelse{\boolean{@dohyper}}{% 
     32%     \RequirePackage[usenames]{color} 
     33%     \definecolor{darkblue}{rgb}{0,0.05,0.35} 
     34% %     \RequirePackage[dvips, pagebackref, bookmarks=true, bookmarksopen=false, pdfpagemode=UseOutlines, colorlinks=true, linkcolor=black, anchorcolor=black, citecolor=black, filecolor=black, menucolor=black, pagecolor=black, urlcolor=darkblue]{hyperref} 
     35%     \RequirePackage[urlcolor=blue,linkcolor=blue,bookmarksopen,bookmarksopenlevel=2,pdftex,pagebackref,pdftitle={FiPy}, pdfcreator={epydoc 2.1}, bookmarks=true, bookmarksopen=false, pdfpagemode=UseOutlines,colorlinks=true,plainpages=false,pdfpagelabels]{hyperref} 
     36% }{} 
    2937 
    3038\setlength{\parindent}{0ex} 
    … …  
    3341 
    3442 
    35 \@ifclassloaded{memoir}{% 
    36     \RequirePackage[other,notbib]{tocbibind} 
    37 }{% 
    38     \RequirePackage{fancyhdr,makeidx} 
    39     \RequirePackage[other]{tocbibind} 
    40     \pagestyle{fancy} 
    41 } 
     43% \@ifclassloaded{memoir}{% 
     44%     \RequirePackage[other,notbib]{tocbibind} 
     45% }{% 
     46%     \RequirePackage{fancyhdr,makeidx} 
     47%     \RequirePackage[other]{tocbibind} 
     48%     \pagestyle{fancy} 
     49% } 
     50\pagestyle{fancy} 
    4251 
    4352\renewcommand{\sectionmark}[1]{\markboth{#1}{}} 
    4453\renewcommand{\subsectionmark}[1]{\markright{#1}} 
     54 
     55\definecolor{py@keywordcolour}{rgb}{1,0.45882,0} 
     56\definecolor{py@stringcolour}{rgb}{0,0.666666,0} 
     57\definecolor{py@commentcolour}{rgb}{1,0,0} 
     58\definecolor{py@ps1colour}{rgb}{0.60784,0,0} 
     59\definecolor{py@ps2colour}{rgb}{0.60784,0,1} 
     60\definecolor{py@inputcolour}{rgb}{0,0,0} 
     61\definecolor{py@outputcolour}{rgb}{0,0,1} 
     62\definecolor{py@exceptcolour}{rgb}{1,0,0} 
     63\definecolor{py@builtincolour}{rgb}{0.58039,0,0.58039} 
     64\definecolor{py@identifiercolour}{rgb}{0,0,0} 
     65\definecolor{py@linenumcolour}{rgb}{0.4,0.4,0.4} 
     66\definecolor{py@inputcolour}{rgb}{0,0,0} 
     67% Prompt 
     68\newcommand{\pysrcprompt}[1]{\textcolor{py@ps1colour} 
     69   {\small\textbf{#1}}} 
     70\newcommand{\pysrcmore}[1]{\textcolor{py@ps2colour} 
     71   {\small\textbf{#1}}} 
     72% Source code 
     73\newcommand{\pysrckeyword}[1]{\textcolor{py@keywordcolour} 
     74   {\small\textbf{#1}}} 
     75\newcommand{\pysrcbuiltin}[1]{\textcolor{py@builtincolour} 
     76   {\small\textbf{#1}}} 
     77\newcommand{\pysrcstring}[1]{\textcolor{py@stringcolour} 
     78   {\small\textbf{#1}}} 
     79\newcommand{\pysrcother}[1]{\small\textbf{#1}} 
     80% Comments 
     81\newcommand{\pysrccomment}[1]{\textcolor{py@commentcolour} 
     82   {\small\textbf{#1}}} 
     83% Output 
     84\newcommand{\pysrcoutput}[1]{\textcolor{py@outputcolour} 
     85   {\small\textbf{#1}}} 
     86% Exceptions 
     87\newcommand{\pysrcexcept}[1]{\textcolor{py@exceptcolour} 
     88   {\small\textbf{#1}}} 
    4589 
    4690\newenvironment{Ventry}[1]% 
    … …  
    66110     
    67111    \large{#1} 
     112     
    68113    }} 
    69114    {} 
    70115     
    71 \newenvironment{EpydocFunction}{% 
    72     \begin{boxedminipage}{\textwidth}} 
     116\newenvironment{EpydocFunction}[2]{% 
     117    \newcommand{\and}{, }% 
     118    \newcommand{\VarArg}[1]{*\textit{##1}}% 
     119    \newcommand{\GenericArg}{\textit{\ldots}}% 
     120    \newcommand{\KWArg}[1]{**\textit{##1}}% 
     121    \newcommand{\ArgList}[1]{(##1)}% 
     122    \newcommand{\Param}[2][]{% 
     123        \textit{##2}% 
     124        \ifthenelse{\equal{##1}{}}{}{=\TX@verb|##1|}}% 
     125    \vspace{0.5ex} 
     126    \def\@EpydocFunctionLine{% 
     127        \vspace{-1.5ex} 
     128            \rule{\textwidth}{0.5\fboxrule} 
     129        \aftergroup\def\aftergroup\@EpydocFunctionLine\aftergroup{\aftergroup}}% 
     130    \begin{boxedminipage}{\textwidth} 
     131        \raggedright \textbf{#1}(#2)} 
    73132    {\end{boxedminipage}} 
    74133 
    75134\newenvironment{EpydocDocstring}{% 
    76     \vspace{-1.5ex} 
    77  
    78     \rule{\textwidth}{0.5\fboxrule}} 
     135    \@EpydocFunctionLine} 
    79136    {\vspace{1ex}} 
    80137 
    … …  
    91148     
    92149\newenvironment{EpydocFunctionParameters}[1]{% 
    93     \textbf{Parameters} 
     150    \@EpydocFunctionLine 
     151    \textbf{Parameters}% 
    94152    \begin{quote} 
    95     \begin{Ventry}{#1} 
    96          
     153    \begin{Ventry}{#1}} 
     154    {\end{Ventry} 
     155    \end{quote} 
     156    %\vspace{1ex} 
    97157    } 
    98     {\end{Ventry} 
    99  
    100     \end{quote} 
    101  
    102     \vspace{1ex} 
    103  
    104     } 
    105158     
    106159\newcommand{\EpydocFunctionReturns}[2][]{% 
    107     \textbf{Return Value} 
     160    \@EpydocFunctionLine 
     161    \textbf{Return Value}% 
    108162    \begin{quote} 
    109         \ifthenelse{\equal{#2}{}}{#1}{% 
     163        \ifthenelse{\equal{#1}{}}{#2}{% 
    110164            #2 \textit{(type=#1)}% 
    111165        } 
    112166    \end{quote} 
    113     \vspace{1ex}} 
     167    %\vspace{1ex} 
     168    } 
    114169 
    115170\newenvironment{EpydocFunctionRaises}{% 
    116171    \renewcommand*{\descriptionlabel}[1]{\hspace\labelsep 
    117172       \normalfont\itshape ##1} 
     173    \@EpydocFunctionLine 
    118174    \textbf{Raises} 
    119175    \begin{quote} 
    … …  
    122178    {\end{description} 
    123179    \end{quote} 
    124     \vspace{1ex}} 
     180    %\vspace{1ex} 
     181    } 
    125182 
    126183\newcommand{\EpydocFunctionOverrides}[2][0]{% 
     184    \@EpydocFunctionLine 
    127185    Overrides: #2 % 
    128186    \ifthenelse{#1=1}{\textit{(inherited documentation)}{}}} 
    … …  
    138196 
    139197\newenvironment{EpydocDescriptionShortList}[1]{% 
    140     \renewcommand{\and}{, }% 
     198    \newcommand{\and}{, }% 
    141199    \textbf{#1: }} 
    142200    {} 
    … …  
    178236    {\end{itemize}} 
    179237 
     238% \newenvironment{@EpydocGeneralList}{% 
     239%     \newcommand{\EpydocInternalHeader}[1]{% 
     240%         \multicolumn{2}{|l|}{\textbf{##1}} \\ 
     241%          \cline{1-2}}% 
     242%     \newcommand{\EpydocInheritanceItemLine}[2]{% 
     243%         \multicolumn{2}{|p{\textwidth}|}{% 
     244%             \textbf{Inherited from {##1}: ##2}}} 
     245%     \begin{longtable}{|p{.30\textwidth}|p{.62\textwidth}|l} 
     246%     \cline{1-2} 
     247%     % Set up the headers & footer (this makes the table span 
     248%     % multiple pages in a happy way). 
     249%     \cline{1-2} \centering \textbf{Name} & \centering \textbf{Description}& \\ 
     250%     \cline{1-2} 
     251%     \endhead\cline{1-2}\multicolumn{3}{r}{\small\textit{continued on next page}}\\\endfoot\cline{1-2} 
     252%     \endlastfoot} 
     253%     {\end{longtable}} 
     254 
    180255\newenvironment{@EpydocGeneralList}{% 
    181256    \newcommand{\EpydocInternalHeader}[1]{% 
    182         \multicolumn{2}{|l|}{\textbf{##1}\\ 
    183         \cline{1-2}}}% 
     257        \multicolumn{2}{|l|}{\textbf{##1}} \\ 
     258         \hline}% 
    184259    \newcommand{\EpydocInheritanceItemLine}[2]{% 
    185260        \multicolumn{2}{|p{\textwidth}|}{% 
    186261            \textbf{Inherited from {##1}: ##2}}} 
    187     \begin{longtable}{|p{.30\textwidth}|p{.62\textwidth}|l} 
    188     \cline{1-2} 
     262    \begin{longtable}{|p{.30\textwidth}|p{.62\textwidth}|} 
    189263    % Set up the headers & footer (this makes the table span 
    190264    % multiple pages in a happy way). 
    191     \cline{1-2} \centering \textbf{Name} & \centering \textbf{Description}& \\ 
    192     \cline{1-2} 
    193     \endhead\cline{1-2}\multicolumn{3}{r}{\small\textit{continued on next page}}\\\endfoot\cline{1-2} 
     265    \hline  
     266    \centering \textbf{Name} & \centering \textbf{Description}  
     267    \tabularnewline 
     268    \hline 
     269    \endhead\hline\multicolumn{2}{r}{\small\textit{continued on next page}}\\\endfoot\hline 
    194270    \endlastfoot} 
    195271    {\end{longtable}} 
    196      
    197 \newenvironment{EpydocVariableList}{% 
     272 
     273% \newenvironment{EpydocVariablesList}{% 
     274%     \newenvironment{EpydocLongValue}{% 
     275%         \begin{alltt}} 
     276%         {\end{alltt}}% 
     277%     \newcommand{\EpydocShortValue}[1]{\texttt{##1}} 
     278%     \newcommand{\EpydocVariable}[4]{% 
     279%         \raggedright ##1 & \raggedright ##2 
     280%         \ifthenelse{\equal{##3}{}\AND\equal{##4}{}}{}{ 
     281%             \ifthenelse{\equal{##3}{}}{}{\textbf{Value:} ##3 } 
     282%             \ifthenelse{\equal{##4}{}}{}{\textit{(type=##4)}}} 
     283%         & \\ 
     284%         \cline{1-2}} 
     285%     \begin{@EpydocGeneralList}} 
     286%     {\end{@EpydocGeneralList}} 
     287 
     288% \newenvironment{EpydocVariablesList}{% 
     289%     \newenvironment{EpydocLongValue}{% 
     290%         \begin{alltt}} 
     291%         {\end{alltt}}% 
     292%     \newcommand{\EpydocShortValue}[1]{\texttt{##1}} 
     293%     \newcommand{\EpydocVariable}[4]{% 
     294%         \raggedright ##1 & \raggedright ##2 
     295%         \ifthenelse{\equal{##3}{}\AND\equal{##4}{}}{}{ 
     296%             \ifthenelse{\equal{##2}{}}{}{ 
     297%              
     298%             } 
     299%             \ifthenelse{\equal{##3}{}}{}{\textbf{Value:} ##3 } 
     300%             \ifthenelse{\equal{##4}{}}{}{\textit{(type=##4)}}} 
     301%         & \\ 
     302%         \cline{1-2}} 
     303%     \begin{@EpydocGeneralList}} 
     304%     {\end{@EpydocGeneralList}} 
     305 
     306\newenvironment{EpydocVariablesList}{% 
    198307    \newenvironment{EpydocLongValue}{% 
    199308        \begin{alltt}} 
    … …  
    201310    \newcommand{\EpydocShortValue}[1]{\texttt{##1}} 
    202311    \newcommand{\EpydocVariable}[4]{% 
    203         \raggedright ##1 & 
    204         \ifthenelse{\equal{##3}{}\AND\equal{##4}{}}{}{\raggedright} 
    205         \ifthenelse{\equal{##3}{}}{}{\textbf{Value:} ##3 } 
    206         \ifthenelse{\equal{##4}{}}{}{\textit{(type=##4)}} 
    207         & \\ 
    208         \cline{1-2}} 
     312        \raggedright ##1 & \raggedright ##2 
     313        \ifthenelse{\equal{##3}{}\AND\equal{##4}{}}{}{% 
     314 
     315            \ifthenelse{\equal{##3}{}}{}{\textbf{Value:} ##3 } 
     316            \ifthenelse{\equal{##4}{}}{}{\textit{(type=##4)}}} 
     317        \tabularnewline 
     318        \hline} 
    209319    \begin{@EpydocGeneralList}} 
    210320    {\end{@EpydocGeneralList}} 
    211      
     321 
     322% \newenvironment{EpydocVariablesList}{% 
     323%     \newenvironment{EpydocLongValue}{% 
     324%         \begin{alltt}} 
     325%         {\end{alltt}}% 
     326%     \newcommand{\EpydocShortValue}[1]{\texttt{##1}} 
     327%     \newcommand{\EpydocVariable}[4]{% 
     328%         \raggedright ##1 &  
     329%           \def\@EpydocVariableSep{} 
     330%           \def\@EpydocVariableValue{} 
     331%           \def\@EpydocVariableType{} 
     332%           \ifthenelse{\equal{##3}{}\AND\equal{##4}{}}{}{% 
     333%               \ifthenelse{\equal{##2}{}}{}{\def\@EpydocVariableSep{ 
     334%                
     335%               }}% 
     336%               \ifthenelse{\equal{##3}{}}{}{\def\@EpydocVariableValue{\textbf{Value:} ##3 }} 
     337%               \ifthenelse{\equal{##4}{}}{}{\def\@EpydocVariableType{\textit{(type=##4)}}}} 
     338%           \raggedright ##2  
     339%           \@EpydocVariableSep  
     340%           \@EpydocVariableValue \@EpydocVariableType} 
     341%         & \\ 
     342%         \cline{1-2}} 
     343%     \begin{@EpydocGeneralList}} 
     344%     {\end{@EpydocGeneralList}} 
     345 
     346 
     347% \newenvironment{EpydocVariablesList}{% 
     348%     \newenvironment{EpydocLongValue}{% 
     349%         \begin{alltt}} 
     350%         {\end{alltt}}% 
     351%     \newcommand{\EpydocShortValue}[1]{\texttt{##1}} 
     352%     \newcommand{\EpydocVariable}[4]{% 
     353%         \raggedright ##1 & \raggedright% 
     354%         \ifthenelse{\equal{##2}{}}{ 
     355%             \ifthenelse{\equal{##3}{}}{}{\textbf{Value:} ##3 } 
     356%             \ifthenelse{\equal{##4}{}}{}{\textit{(type=##4)}}} 
     357%         {\ifthenelse{\equal{##3}{}\AND\equal{##4}{}}{##2}{##2 
     358%              
     359%             \ifthenelse{\equal{##3}{}}{}{\textbf{Value:} ##3 } 
     360%             \ifthenelse{\equal{##4}{}}{}{\textit{(type=##4)}}}} 
     361%         & \\ 
     362%         \cline{1-2}} 
     363%     \begin{@EpydocGeneralList}} 
     364%     {\end{@EpydocGeneralList}} 
     365 
     366% \newenvironment{EpydocVariablesList}{% 
     367%     \newenvironment{EpydocLongValue}{% 
     368%         \begin{alltt}} 
     369%         {\end{alltt}}% 
     370%     \newcommand{\EpydocShortValue}[1]{\texttt{##1}} 
     371%     \newcommand{\EpydocVariable}[4]{% 
     372%         \raggedright ##1 & \raggedright% 
     373%         \ifthenelse{\equal{##2}{}}{ 
     374%             \ifthenelse{\equal{##3}{}}{}{\textbf{Value:} ##3 } 
     375%             \ifthenelse{\equal{##4}{}}{}{\textit{(type=##4)}}} 
     376%         {\ifthenelse{\equal{##3}{}\AND\equal{##4}{}}{##2}{##2 
     377%              
     378%             \ifthenelse{\equal{##3}{}}{}{\textbf{Value:} ##3 } 
     379%             \ifthenelse{\equal{##4}{}}{}{\textit{(type=##4)}}}} 
     380%         & \\ 
     381%         \cline{1-2}} 
     382%     \begin{@EpydocGeneralList}} 
     383%     {\end{@EpydocGeneralList}} 
     384 
     385\newenvironment{EpydocClassVariablesList}{% 
     386    \begin{EpydocVariablesList}} 
     387    {\end{EpydocVariablesList}} 
     388 
     389\newenvironment{EpydocInstanceVariablesList}{% 
     390    \begin{EpydocVariablesList}} 
     391    {\end{EpydocVariablesList}} 
     392 
    212393% \newenvironment{EpydocVariableList}{% 
    213394%     \newcommand{\EpydocInternalHeader}[1]{% 
    … …  
    248429%     {\end{longtable}} 
    249430 
    250 \newenvironment{EpydocPropertyList}{% 
     431\newenvironment{EpydocPropertiesList}{% 
    251432    \newcommand{\EpydocProperty}[2]{% 
    252433        \raggedright ##1 & 
    … …  
    254435        & \\ 
    255436        \cline{1-2}} 
    256     \begin{@EpydocGeneralList}} 
    257     {\end{@EpydocGeneralList}} 
     437    \begin{EpydocVariablesList}} 
     438    {\end{EpydocVariablesList}} 
    258439 
    259440% \newenvironment{EpydocPropertyList}{% 

  • trunk/documentation/manual/fipy.sty

    r1954 r2763  
    11\NeedsTeXFormat{LaTeX2e} %[1995/12/01] 
    22\ProvidesPackage{fipy} 
    3              [2004/10/07 Document style (FiPy manual)] 
     3             [2008/10/09 Document style (FiPy manual)] 
     4 
     5% Pass options to the epydoc base package. 
     6\RequirePackage{xkeyval} 
     7\DeclareOptionX{index}{\PassOptionsToPackage{index}{examples/latex/epydoc-base}} 
     8\DeclareOptionX{hyperlink}{\PassOptionsToPackage{hyperlink}{examples/latex/epydoc-base}} 
     9\DeclareOptionX{title}[]{\PassOptionsToPackage{title={#1}}{examples/latex/epydoc-base}} 
     10\DeclareOptionX{creator}[]{\PassOptionsToPackage{creator={#1}}{examples/latex/epydoc-base}} 
     11 
     12% Put Part as topmost level in PDF bookmarks 
     13\def\tocPDFlevel{-1} 
     14\DeclareOptionX{tocAsPDFpart}{\def\tocPDFlevel{-1}} 
     15\DeclareOptionX{tocAsPDFchapter}{\def\tocPDFlevel{0}} 
     16 
     17\ProcessOptionsX\relax 
     18 
     19% \usepackage{xr-hyper} 
     20 
     21\RequirePackage[hyperlink,linkcolor=blue]{examples/latex/epydoc-base} 
     22% \RequirePackage[hyperlink]{examples/latex/epydoc-shaded} 
     23\RequirePackage{longtable} 
     24 
     25\RequirePackage{crop} 
     26 
     27% \tocotherhead{part} 
     28% \renewcommand{\bibsection}{%  
     29% \part{\bibname}  
     30% \prebibhook} 
     31 
     32\renewcommand{\bibsection}{%  
     33\chapter*{\bibname}  
     34\bibmark  
     35\ifnobibintoc\else  
     36\phantomsection  
     37\addcontentsline{toc}{part}{\bibname}  
     38\fi  
     39\prebibhook} 
     40 
     41\setlength{\columnsep}{35pt} 
     42 
     43\RequirePackage{amsmath}  
     44 
     45\DeclareMathOperator{\erf}{erf} 
     46\newcommand{\abs}[1]{\lvert#1\rvert} 
     47 
     48\RequirePackage[usenames]{color} 
     49\definecolor{UrlColor}{rgb}{0,0.08,0.45} 
     50% \RequirePackage[pdftex, hyperfigures=true, pagebackref, pdftitle={FiPy User's Guide}, pdfcreator={epydoc 3.0beta1}, bookmarks=true, bookmarksopen, bookmarksopenlevel=2, pdfpagemode=UseOutlines, colorlinks=true, plainpages=false, pdfpagelabels, linkcolor=blue, anchorcolor=black, citecolor=black, filecolor=black, menucolor=black, pagecolor=black, urlcolor=UrlColor]{hyperref} 
     51 
     52\RequirePackage[tight]{minitoc} 
     53\setcounter{parttocdepth}{2} 
     54\mtcsetrules{parttoc}{off} 
     55 
     56\definecolor{darkblue}{rgb}{0,0.05,0.35} 
     57\definecolor{redish}{rgb}{0.894,0.122,0.122} 
     58\definecolor{bluish}{rgb}{0.216,0.188,0.533} 
     59% \RequirePackage[pdftex]{graphicx} 
     60 
     61\graphicspath{{./api/latex/},{../figures/},{images/}} 
     62 
     63\renewcommand{\sectionmark}[1]{\markboth{#1}{}} 
     64\renewcommand{\subsectionmark}[1]{\markright{#1}} 
     65 
     66\newenvironment{changemargin}[2]{% 
     67 \begin{list}{}{% 
     68  \setlength{\topsep}{0pt}% 
     69  \setlength{\leftmargin}{#1}% 
     70  \setlength{\rightmargin}{#2}% 
     71  \setlength{\listparindent}{\parindent}% 
     72  \setlength{\itemindent}{\parindent}% 
     73  \setlength{\parsep}{\parskip}% 
     74 }% 
     75\item[]}{\end{list}} 
     76 
     77\renewcommand\tableofcontents{% 
     78    \if@twocolumn 
     79      \@restonecoltrue\onecolumn 
     80    \else 
     81      \@restonecolfalse 
     82    \fi 
     83    \chapter*{\contentsname\pdfbookmark[\tocPDFlevel]{Contents}{contents} 
     84        \@mkboth{% 
     85           \MakeUppercase\contentsname}{\MakeUppercase\contentsname}}% 
     86    \@starttoc{toc}% 
     87    \if@restonecol\twocolumn\fi 
     88    } 
     89 
     90\newcounter{FAQdepth} 
     91\setcounter{FAQdepth}{0} 
     92 
     93\newenvironment{FAQ}% 
     94               {\list{}{\stepcounter{FAQdepth}% 
     95                        \labelwidth\z@ \itemindent-\leftmargin 
     96                        \let\makelabel\FAQlabel}}% 
     97               {\addtocounter{FAQdepth}{-1}% 
     98               \endlist} 
     99\newcommand*{\FAQlabel}[1]{\hspace\labelsep 
     100                                   \normalfont\bfseries #1% 
     101                           \ifnum\value{FAQdepth}=1\relax 
     102                               \addcontentsline{toc}{section}{#1} 
     103                           \else\ifnum\value{FAQdepth}=2\relax 
     104                               \addcontentsline{toc}{subsection}{#1}    
     105                           \fi 
     106                           \fi\adjustmtc} 
     107                            
     108                            
     109\newcommand{\@Code}[1]{\texttt{#1}} 
     110\newcommand{\IndexClass}[1]{\index{#1@\protect\EpydocIndex{#1}{\EpydocDottedName{#1}}{class} class}} 
     111\newcommand{\IndexModule}[1]{\index{#1@\protect\EpydocIndex{#1}{\EpydocDottedName{#1}}{module} module}} 
     112\newcommand{\IndexPackage}[1]{\index{#1@\protect\EpydocIndex{#1}{\EpydocDottedName{#1}}{package} package}} 
     113\newcommand{\IndexSoftware}[1]{\index{#1@\@Software{#1}}} 
     114\newcommand{\IndexFunction}[1]{\index{#1@\protect\EpydocIndex{#1}{\EpydocDottedName{#1}}{function}}} 
     115\newcommand{\IndexConstant}[2]{\index{$#1\equiv\text{#2}$@$#1\equiv\text{\protect\EpydocIndex{#2}{\EpydocDottedName{#2}}{module}}$}% 
     116                               \index{#2$\equiv #1$@$\text{\protect\EpydocIndex{#2}{\EpydocDottedName{#2}}{module}}\equiv #1$}} 
     117\newcommand{\Class}[1]{\@Code{#1}\IndexClass{#1}} 
     118\newcommand{\Module}[1]{\@Code{#1}\IndexModule{#1}} 
     119 
     120% commands for various weblinks 
     121%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 
     122 
     123\newcommand{\@Software}[1]{\textsf{#1}} 
     124\newcommand{\@Org}[1]{\textsf{#1}} 
     125 
     126\newcommand{\FiPy}{\@Software{FiPy}} 
     127 
     128\newcommand{\@OrgURL}[2]{\href{#2}{\@Org{#1}}\index{#1@\@Org{#1}}} 
     129 
     130\newcommand{\@SoftwareURL}[2]{\href{#2}{\@Software{#1}}\IndexSoftware{#1}} 
     131 
     132\newcommand{\SciPy}{\@SoftwareURL{SciPy}{http://www.scipy.org/}} 
     133 
     134\newcommand{\PyRex}{\@SoftwareURL{PyRex}{http://www.cosc.canterbury.ac.nz/~greg/python/Pyrex/}} 
     135 
     136\newcommand{\Python}{\@SoftwareURL{Python}{http://www.python.org/}} 
     137 
     138\newcommand{\Numeric}{\@SoftwareURL{Numeric}{http://www.numpy.org/}} 
     139 
     140\newcommand{\PyX}{\@SoftwareURL{PyX}{http://pyx.sourceforge.net/}} 
     141 
     142\newcommand{\Pygist}{\@SoftwareURL{Pygist}{http://bonsai.ims.u-tokyo.ac.jp/~mdehoon/software/python/pygist.html}% 
     143                     \IndexSoftware{gist}} 
     144 
     145\newcommand{\Matplotlib}{\@SoftwareURL{Matplotlib}{http://matplotlib.sourceforge.net}} 
     146 
     147\newcommand{\MayaVi}{\@SoftwareURL{MayaVi}{http://mayavi.sourceforge.net}} 
     148 
     149\newcommand{\PySparse}{\@SoftwareURL{PySparse}{http://people.web.psi.ch/geus/pyfemax/pysparse.html}} 
     150 
     151\newcommand{\ScientificPython}{\@SoftwareURL{Scientific Python}{http://starship.python.net/~hinsen/ScientificPython/}} 
     152 
     153\newcommand{\MacOSX}{\@SoftwareURL{Mac OS X}{http://www.apple.com/macosx/}} 
     154 
     155\newcommand{\Gmsh}{\@SoftwareURL{Gmsh}{http://www.geuz.org/gmsh/}} 
     156 
     157\newcommand{\weave}{\@SoftwareURL{weave}{http://www.scipy.org/documentation/weave/}} 
     158 
     159\newcommand{\blitz}{\@SoftwareURL{blitz}{http://www.scipy.org/documentation/weave/}} 
     160 
     161\newcommand{\doctest}{\@SoftwareURL{doctest}{http://www.python.org/doc/current/lib/module-doctest.html}}</