[Bf-docboard] Planning

Stefano Selleri bf-docboard@blender.org
Mon, 28 Jun 2004 13:35:23 +0200


This is a multi-part message in MIME format.

------=_NextPart_000_02A8_01C45D14.C3503840
Content-Type: text/plain;
	charset="iso-8859-1"
Content-Transfer-Encoding: quoted-printable

Oh!

solution!

THe epydoc sources are on the CVS of blender sources

[bf-blender] / blender / source / blender / python / api2_2x / doc=20

Stefano
  ----- Original Message -----=20
  From: Martin Middleton=20
  To: bf-docboard@blender.org=20
  Sent: Monday, June 28, 2004 12:52 PM
  Subject: Re: [Bf-docboard] Planning


  At 08:31 AM 5/3/2004, you wrote:

  [ text snipped]

        THe Python group is using epydoc for Python API doc, I would =
like

        to include it in the Online doc as an organic part, not as an =
external object.



        epydoc traslates to HTML and PDF directly, without passing =
through

        DocBook :(



        I found a java DocLet translating HTML to XML so I can take the =
HTML generated

        by epydoc and convert it to DocBook BUT:



        1 - Result is quite poor


    Is the HTML generated by epydoc of poor quality, or is it the result =
of converting the HTML to XML?


    The HTML from epydoc is *very* nice, and is online :)
    =20
    The  HTML obtained from the XML pbtained from the HTML obtained from =
epydoc is not nice...




        2 - THe resulting XML generates a (poor quality) HTML but does =
NOT generate a PDF

            because LateX capacity are exceeded (sorry)



        Hence I'm still in trouble for this.



        Ideal thing would be an epydoc -> DocBook converter but any =
other suggestion is welcome :)



    >I'll look into this. If I come up with a solution, I'll let you =
know.
    Thanx a lot :)

  I think I may have found a solution to this. Could you point me to an =
existing epydoc source document, so I can do some testing?


  - Oso=20

------=_NextPart_000_02A8_01C45D14.C3503840
Content-Type: text/html;
	charset="iso-8859-1"
Content-Transfer-Encoding: quoted-printable

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML><HEAD>
<META http-equiv=3DContent-Type content=3D"text/html; =
charset=3Diso-8859-1">
<META content=3D"MSHTML 6.00.2800.1400" name=3DGENERATOR>
<STYLE></STYLE>
</HEAD>
<BODY bgColor=3D#ffffff>
<DIV><FONT face=3DArial size=3D2>Oh!</FONT></DIV>
<DIV><FONT face=3DArial size=3D2></FONT>&nbsp;</DIV>
<DIV><FONT face=3DArial size=3D2>solution!</FONT></DIV>
<DIV><FONT face=3DArial size=3D2></FONT>&nbsp;</DIV>
<DIV><FONT face=3DArial size=3D2>THe epydoc sources are on the CVS of =
blender=20
sources</FONT></DIV>
<DIV><!--StartFragment --></TD><TD><B></B></DIV>
<DIV><B><A=20
href=3D"http://projects.blender.org/viewcvs/viewcvs.cgi/?cvsroot=3Dbf-ble=
nder#dirlist">[bf-blender]</A>=20
/ <A=20
href=3D"http://projects.blender.org/viewcvs/viewcvs.cgi/blender/?cvsroot=3D=
bf-blender#dirlist">blender</A>=20
/ <A=20
href=3D"http://projects.blender.org/viewcvs/viewcvs.cgi/blender/source/?c=
vsroot=3Dbf-blender#dirlist">source</A>=20
/ <A=20
href=3D"http://projects.blender.org/viewcvs/viewcvs.cgi/blender/source/bl=
ender/?cvsroot=3Dbf-blender#dirlist">blender</A>=20
/ <A=20
href=3D"http://projects.blender.org/viewcvs/viewcvs.cgi/blender/source/bl=
ender/python/?cvsroot=3Dbf-blender#dirlist">python</A>=20
/ <A=20
href=3D"http://projects.blender.org/viewcvs/viewcvs.cgi/blender/source/bl=
ender/python/api2_2x/?cvsroot=3Dbf-blender#dirlist">api2_2x</A>=20
/ doc</B></TD> </DIV>
<DIV><STRONG></STRONG>&nbsp;</DIV>
<DIV><STRONG>Stefano</STRONG></DIV>
<BLOCKQUOTE dir=3Dltr=20
style=3D"PADDING-RIGHT: 0px; PADDING-LEFT: 5px; MARGIN-LEFT: 5px; =
BORDER-LEFT: #000000 2px solid; MARGIN-RIGHT: 0px">
  <DIV style=3D"FONT: 10pt arial">----- Original Message ----- </DIV>
  <DIV=20
  style=3D"BACKGROUND: #e4e4e4; FONT: 10pt arial; font-color: =
black"><B>From:</B>=20
  <A title=3Dmartin.middleton@verizon.net=20
  href=3D"mailto:martin.middleton@verizon.net">Martin Middleton</A> =
</DIV>
  <DIV style=3D"FONT: 10pt arial"><B>To:</B> <A =
title=3Dbf-docboard@blender.org=20
  href=3D"mailto:bf-docboard@blender.org">bf-docboard@blender.org</A> =
</DIV>
  <DIV style=3D"FONT: 10pt arial"><B>Sent:</B> Monday, June 28, 2004 =
12:52=20
PM</DIV>
  <DIV style=3D"FONT: 10pt arial"><B>Subject:</B> Re: [Bf-docboard] =
Planning</DIV>
  <DIV><FONT face=3DArial size=3D2></FONT><BR></DIV>At 08:31 AM =
5/3/2004, you=20
  wrote:<BR><BR>[ text snipped]<BR>
  <BLOCKQUOTE class=3Dcite cite=3D"" type=3D"cite">
    <BLOCKQUOTE class=3Dcite cite=3D"" type=3D"cite">
      <DL>
        <DD><FONT face=3Darial size=3D2>THe Python group is using epydoc =
for Python=20
        API doc, I would like<BR>
        <DD>to include it in the Online doc as an organic part, not as =
an=20
        external object.<BR></FONT>
        <DD><BR>&nbsp;
        <DD><FONT face=3Darial size=3D2>epydoc traslates to HTML and PDF =
directly,=20
        without passing through<BR>
        <DD>DocBook :(<BR></FONT>
        <DD><BR>&nbsp;
        <DD><FONT face=3Darial size=3D2>I found a java DocLet =
translating HTML to=20
        XML so I can take the HTML generated<BR>
        <DD>by epydoc and convert it to DocBook BUT:<BR></FONT>
        <DD><BR>&nbsp;
        <DD><FONT face=3Darial size=3D2>1 - Result is quite=20
    poor</FONT></DD></DL></BLOCKQUOTE><BR>
    <DD>Is the HTML generated by epydoc of poor quality, or is it the =
result of=20
    converting the HTML to XML?<BR><BR>
    <DL></DL><FONT face=3Darial size=3D2>The HTML from epydoc is *very* =
nice, and is=20
    online :)<BR></FONT>&nbsp;<BR><FONT face=3Darial size=3D2>The&nbsp; =
HTML=20
    obtained from the XML pbtained from the HTML obtained from epydoc is =
not=20
    nice...<BR></FONT><BR>
    <BLOCKQUOTE class=3Dcite cite=3D"" type=3D"cite">
      <DL><BR>
        <DD><FONT face=3Darial size=3D2>2 - THe resulting XML generates =
a (poor=20
        quality) HTML but does NOT generate a PDF<BR>
        <DD>&nbsp;&nbsp;&nbsp; because LateX capacity are exceeded=20
        (sorry)<BR></FONT>
        <DD><BR>&nbsp;
        <DD><FONT face=3Darial size=3D2>Hence I'm still in trouble for=20
        this.<BR></FONT>
        <DD><BR>&nbsp;
        <DD><FONT face=3Darial size=3D2>Ideal thing would be an epydoc =
-&gt; DocBook=20
        converter but any other suggestion is welcome=20
    :)</FONT></DD></DL></BLOCKQUOTE><BR>
    <DL></DL><BR>&gt;I'll look into this. If I come up with a solution, =
I'll let=20
    you know.<BR><FONT face=3Darial size=3D2>Thanx a lot=20
  :)</FONT></DD></BLOCKQUOTE><BR>I think I may have found a solution to =
this.=20
  Could you point me to an existing epydoc source document, so I can do =
some=20
  testing?<BR><BR><X-SIGSEP>
  <P></X-SIGSEP>- Oso </P></BLOCKQUOTE></BODY></HTML>

------=_NextPart_000_02A8_01C45D14.C3503840--