On Tue, Dec 16, 2008 at 15:10, Michael Droettboom <md...@stsci.edu> wrote:
> One question to ask is whether we need both the .pdf and .html manuals, or
> whether that could be broken up into two packages.  That seems like an easy
> one if that fits Debian policies (which I know nothing about) -- and
> wouldn't degrade the documentation experience at all.

Well, if you're talking about Matplotlib.pdf, the whole manual in pdf
format, then maybe it doesn't worth: we already have a separate
package for documentation, so I think that all doc should be there
(with an adequate size :) ).

> Is there any way to transparently gzip compress the html files (as I believe
> Debian does with manpages)?

sadly, the compression of manpage is handled directly by "man"
executable, that uncompress and pipe the manpage into a PAGER. html
pages are rendered by web browser, and in case of local documentation,
the pages are read from local disk (so so web server to
"uncompress"-on-the-fly).

> Another option would be to not generate the high-res png and pdf examples.
>  (Either or both).

that would be great. while pdf images are not that useful (at least
from my pov: I'm browsing web pages, I don't want to spawn a pdf
viewer to look at an image) hires could be "dropped" because even
"normal-res" images seems to give a clear idea of the power of mpl.

> Just removing them after the fact won't work, since one
> would end up with broken links from the docs.  We would also have to change
> the html to not include those links.  It should be fairly simple to provide
> an option to the doc build system to do this, and I'm happy to implement
> that if we all agree that's the direction to take.

FWIW, I really like to see such an option :)

> Beyond that, we'd be looking at selectively including certain examples,
> which I worry would add additional maintenance burden if there's too much
> divergence between the "full" and "small" manuals.  I think that road should
> be a last resort.

If the size it's reasonable, then I would like to generate all the
examples, because... well, I like them! :)

Cheers,
-- 
Sandro Tosi (aka morph, Morpheus, matrixhasu)
My website: http://matrixhasu.altervista.org/
Me at Debian: http://wiki.debian.org/SandroTosi

------------------------------------------------------------------------------
SF.Net email is Sponsored by MIX09, March 18-20, 2009 in Las Vegas, Nevada.
The future of the web can't happen without you.  Join us at MIX09 to help
pave the way to the Next Web now. Learn more and register at
http://ad.doubleclick.net/clk;208669438;13503038;i?http://2009.visitmix.com/
_______________________________________________
Matplotlib-devel mailing list
Matplotlib-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/matplotlib-devel

Reply via email to