#58: hacked epdoc-generated api.tex doesn't compile
---------------------+------------------------------------------------------
Reporter: jguyer | Owner: jguyer
Type: defect | Status: assigned
Priority: 5 | Component: None
Version: None | Severity: Private
Resolution: None | Keywords:
---------------------+------------------------------------------------------
Changes (by guyer):
* type: => defect
Old description:
> {{{
> The hacked version of epydoc in utils/epydoc/ produces a line in the
> master api.tex file:
> \usepackage[index,pdftitle={Title},pdfcreator={epydoc 2.1}]{epydoc} and
> epydoc.sty declares
> \DeclareOption*{\PassOptionsToClass{\CurrentOption}{hyperref}} intending
> to pass the pdftitle and pdfcreator options on to hyperref. This does not
> work, as those options are declared by hyperref using keyval.sty. We need
> to do something similar or come up with some other way to generate these
> options. This is not an issue for our primary use of utils/epydoc/ as a
> way to generate the manuals, since we ignore api.tex in that case, but it
> does mean that the hacked epydoc can't be used on individual files and it
> will certainly need to be fixed before sending to Ed Loper.
> }}}
New description:
The hacked version of epydoc in utils/epydoc/ produces a line in the
master api.tex file: \usepackage[index,pdftitle={Title},pdfcreator={epydoc
2.1}]{epydoc} and epydoc.sty declares
\DeclareOption*{\PassOptionsToClass{\CurrentOption}{hyperref}} intending
to pass the pdftitle and pdfcreator options on to hyperref. This does not
work, as those options are declared by hyperref using keyval.sty. We need
to do something similar or come up with some other way to generate these
options. This is not an issue for our primary use of utils/epydoc/ as a
way to generate the manuals, since we ignore api.tex in that case, but it
does mean that the hacked epydoc can't be used on individual files and it
will certainly need to be fixed before sending to Ed Loper.
Comment:
The solution is to just put the hyperdoc import directly in the file. I'll
incorporate this in my edits to epydoc 3
--
Ticket URL: <https://www.matforge.org/fipy/ticket/58#comment:1>
FiPy <http://www.ctcms.nist.gov/fipy>
A Finite Volume PDE Solver Using Python
