make the genDocXML + convert_doc work

[GoogleCodeExporter]

* finish the work on genDocXML to generate xml correctly
* improve convert_doc to generate the same pdf documentation as genDoc
* improve convert_doc to generate HTML

Original issue reported on code.google.com by ondrej.c...@gmail.com on 22 Feb 2008 at 5:08

[GoogleCodeExporter]

XML -> pdf works now. I committed it directly to our repo. Sfepy needs a little
cleanup anyway, so let's clean it up when it works.

Usage:

$ ./gen

and a file "tmp/t.pdf" is generated. Look into "./gen" for details.

Original comment by ondrej.c...@gmail.com on 24 Feb 2008 at 8:08

[GoogleCodeExporter]

Looks good. I see some glitches only in tables (the alignment character '&' is
printed - it seems that '&' gets translated into '\&') and in lines where a
regular text and a math text is mixed (the regular one is wrongly typeset in 
math
mode - 'termDefinition' needs to be improved). Nice work!

Original comment by robert.c...@gmail.com on 25 Feb 2008 at 9:09

[GoogleCodeExporter]

Yep, those are known problems, which I didn't fix yet. I'll work on it today. 
In the
meantime, try to help me find a good name for it:

http://code.google.com/p/sympy/issues/detail?id=717#c18

Original comment by ondrej.c...@gmail.com on 25 Feb 2008 at 11:59

[GoogleCodeExporter]

OK, so the code in the sfepy hg is always copied from:

http://code.google.com/p/prettydoc/

and everything is now fixed, except the tables, which I fix soon. Maybe you 
will not
like some of the formatting, but as the genDocsXML is concerned, it's only job 
is to
create tmp/terms.xml. We can then customize the output in prettydoc, see this 
issue
for that:

http://code.google.com/p/prettydoc/issues/detail?id=3

Original comment by ondrej.c...@gmail.com on 25 Feb 2008 at 9:07

[GoogleCodeExporter]

I fixed the tables too, plus I implemented customizations, so I put a SfePy 
specific
customization to a separate file script/sfepyconverter.py, see ./gen how it 
works.

Please try it and comment. If you don't like some particular output, this 
should be
fixed in the custom file script/sfepyconverter.py

Only stuff, that is common to all projects should come to prettydoc.

I created a new issue 28 for the html printing.

Now please help me refine the customization + xml generation, so that we get 
the same
output. Then let's get rid of the old genDocs?

Original comment by ondrej.c...@gmail.com on 26 Feb 2008 at 12:26

[GoogleCodeExporter]

I have fixed convert_doc.py to work with Python 2.4 - where should I commit to?
Into prettydoc? How should be the files copied around?

For the moment, I attach the patch here.

Original comment by robert.c...@gmail.com on 26 Feb 2008 at 9:17

Attachments:

• python2.4.patch

[GoogleCodeExporter]

I use python2.4.....

Anyway, if it's a fix to convert_doc.py, fix it in prettydoc and make sure all 
tests
run. Then copy convert_doc.py to sfepy verbatim.

That's my suggested way how to work with this. Any *local* modifications go to 
the
file sfepyconverter.py as explained.

Original comment by ondrej.c...@gmail.com on 26 Feb 2008 at 10:51

[GoogleCodeExporter]

Strange... without the patch, this is what I get:

$ script/convert_doc.py --converter=script/sfepyconverter.py:SfePyDocConverter
tmp/t.xml tmp/t.tex
Traceback (most recent call last):
  File "script/convert_doc.py", line 1058, in ?
    main()
  File "script/convert_doc.py", line 1033, in main
    mod = __import__(mod_name)
ImportError: No module named script/sfepyconverter

with Python 2.4.4

Original comment by robert.c...@gmail.com on 26 Feb 2008 at 11:00

[GoogleCodeExporter]

Weird. Maybe Debian's python 2.4 is different from gentoo's.

Anyway, it's in prettydoc now too. Please try to run prettydoc tests, as 
described on
prettydoc webpage and see if all is ok now.

Original comment by ondrej.c...@gmail.com on 26 Feb 2008 at 12:23

[GoogleCodeExporter]

Ran 5 tests in 6.001s

OK

The generated files look ok.

Original comment by robert.c...@gmail.com on 26 Feb 2008 at 12:49

[GoogleCodeExporter]

This is now obsolete since the documentation is generated by sphinx.

Original comment by robert.c...@gmail.com on 26 Apr 2010 at 1:42

• Changed state: WontFix

[GoogleCodeExporter]

Migrated to http://github.com/sfepy/sfepy/issues/29

Original comment by robert.c...@gmail.com on 30 Jan 2012 at 10:24

• Changed state: Migrated