search

upiterbarg / mpmath

Automatically exported from code.google.com/p/mpmath
Other
0 stars 0 forks source link

generate plots when generating docs #162

Open GoogleCodeExporter opened 9 years ago

GoogleCodeExporter commented 9 years ago 
What steps will reproduce the problem?
1. cd doc
2. ./build.py
3. warning:image file not readable: plot.png and cplot.png

What is the expected output? What do you see instead?
plot.png and cplot.png should be there.

What version of the product are you using? On what operating system?
version 0.13, Fedora 64-bit
see bug: https://bugzilla.redhat.com/show_bug.cgi?id=525192

It would be nice to hear, if this fails only for fedora people (atm at
least 3) or if this is a generell issue…

   Thomas

Original issue reported on code.google.com by thomas.s...@gmail.com on 19 Oct 2009 at 1:06

GoogleCodeExporter commented 9 years ago 
I think the source images are not included in the release tar.gz, but they are
available in an svn checkout. If you are making a package for Fedora, you may 
want to
add them.

Original comment by fredrik....@gmail.com on 19 Oct 2009 at 2:04

GoogleCodeExporter commented 9 years ago 
That's good. This means both images don't need to be generated in the build, 
they are
missing in the tar.gz.
So no problem why building :)

Original comment by thomas.s...@gmail.com on 19 Oct 2009 at 5:45

GoogleCodeExporter commented 9 years ago 
Could you add them in the next release?

Original comment by thomas.s...@gmail.com on 19 Oct 2009 at 5:49

GoogleCodeExporter commented 9 years ago 
There is a problem with that; they would significantly increase the file size.
Perhaps I can make them smaller.

Original comment by fredrik....@gmail.com on 19 Oct 2009 at 5:55

GoogleCodeExporter commented 9 years ago 
What about a seperate tar ball for the images?

Original comment by Vinzent.Steinberg@gmail.com on 29 Oct 2009 at 7:46

GoogleCodeExporter commented 9 years ago 
Good idea. Would also make it easier to add more graphical examples to the docs.

Original comment by fredrik....@gmail.com on 30 Oct 2009 at 2:48

GoogleCodeExporter commented 9 years ago 
I added them for now; 80 KB extra is not the end of the world in this day and 
age.

But we should definitely figure out a way to generate graphics from plot 
commands in
the docstrings when building the docs.

Original comment by fredrik....@gmail.com on 4 Feb 2010 at 1:52

GoogleCodeExporter commented 9 years ago 
Agreed.

Original comment by Vinzent.Steinberg@gmail.com on 4 Feb 2010 at 12:18

GoogleCodeExporter commented 9 years ago 
This should be possible to do using the Sphinx matplotlib extension:
http://matplotlib.sourceforge.net/sampledoc/extensions.html

Original comment by fredrik....@gmail.com on 5 Feb 2010 at 9:33

GoogleCodeExporter commented 9 years ago 
I've added a bunch of images in r1153.

Starting with the next version, the documentation will probably be released 
separately since the images take up quite a lot of space (and more to be added).

It would be possible not to include the images in the doc sources, and just 
generate them with the documentation build script. Unfortunately, it takes 
quite a lot of time to generate all the plots from scratch (especially the 
complex color plots), so I don't know about that.

Alas, I've had no luck with the Sphinx matplotlib extension, so the current 
solution for including plots is a bit of a hack :)

Original comment by fredrik....@gmail.com on 14 Jun 2010 at 7:30

GoogleCodeExporter commented 9 years ago 
So we should probably get in touch with upstream.

Original comment by Vinzent.Steinberg@gmail.com on 14 Jun 2010 at 9:07

GoogleCodeExporter commented 9 years ago 
It's a matplotlib issue (it crashes for me when attempting to import the 
utility modules).

I tried asking on the matplotlib mailing list a while back, but there wasn't 
sufficient information to figure out the cause of the crash.

Original comment by fredrik....@gmail.com on 14 Jun 2010 at 9:10