On Wed, Feb 23, 2011 at 11:52:50AM +1100, Ben Finney wrote: > "W. Trevor King" <[email protected]> writes: > > On Wed, Feb 23, 2011 at 09:10:00AM +1100, Ben Finney wrote: > > > While we're on the subject: the heavy documentation dependencies (in > > > particular, the ‘numpydoc’ dependency) are preventing the progress > > > of packaging version 1.0.0 for Debian. > > > > Don't build the HTML docs then ;). > > That's one workaround, yes. But wouldn't that result in an absence of > any user documentation?
Pre-compiled HTML is on the web, and as a stopgap you could just install the rst source. It is, after all, quite readable. All the really useful documentation is in the `--help` strings and the tutorial anyway. If it was up to me and Sphinx/numpdoc wasn't available, I'd just install the README and doc/tutorial.txt as the package documentation. > > Or remove the numpydoc plugin from doc/conf.py's `extensions`. > > That implies ‘numpydoc’ is not a dependency. Wouldn't the resulting docs > be terrible? They would be a bit worse, but not terrible. Out of curiosity, I just compiled the docs without numpydoc, and I'll leave the results here: http://www.physics.drexel.edu/~wking/be-docs-without-numpydoc/ for the next few days incase anyone else is curious. All the user-directed stuff is fine. Some of the API documentation isn't quite as nice. For example, compare: With numpydoc: http://www.physics.drexel.edu/~wking/code/be/doc/libbe/libbe.util.utility.html#libbe.util.utility.str_to_time Without numpydoc: http://www.physics.drexel.edu/~wking/be-docs-without-numpydoc/libbe/libbe.util.utility.html#libbe.util.utility.str_to_time > > Really, I think Debian should just package numpydoc ;). > > No objection from me, I agree that would be the best solution here. But > the fact is no-one has stepped forward to complete that. Ah, can't help you there. I just skimmed through https://wiki.ubuntu.com/PackagingGuide/Python which was the simplest guide to packaging Python for Debian-based systems, and it looks too complicated for me ;). -- This email may be signed or encrypted with GPG (http://www.gnupg.org). The GPG signature (if present) will be attached as 'signature.asc'. For more information, see http://en.wikipedia.org/wiki/Pretty_Good_Privacy My public key is at http://www.physics.drexel.edu/~wking/pubkey.txt
pgpxWoDxsRBq6.pgp
Description: PGP signature
_______________________________________________ Be-devel mailing list [email protected] http://void.printf.net/cgi-bin/mailman/listinfo/be-devel
