On Sun, Dec 05, 2010 at 06:44:08PM -0500, Chris Ball wrote: > It doesn't have the built man page or HTML docs included, even though > I ran make doc first
release.create_tarball() exports most of the source using `git
archive`, and then copies over specific adjustments
(e.g. libbe/_version.py) explicitly. If we want to distribute
pre-compiled documentation, we'd need to make additions to release.py
similar to what we do for _version.py.
> -- do we want to fix that for the tarball, or leave them for users
> to build?
1) man page
XSLT processors and the DocBook XSL files seem to be well packaged,
so I think it's easy enough for users/packagers to build this
themselves. That said, it's also easy to package the man page, so
I don't mind either way.
2) Sphinx docs
Some distributions don't package the numpydoc Sphinx extension, so
getting that set up might require a
pip install --install-option=--user numpydoc
This is annoying enough that I'd recommend packaging the docs if
they weren't already available online. I don't imagine many users
will bother compiling these themselves with the online versions
readily available. If we're going to distribute something for easy
offline viewing, perhaps the PDF version of the docs would be more
appropriate?
Also,
a) Maybe we shouldn't distribute update_copyright.py, since it's not
much use without the underlying Git repo. I've adjusted release.py
accordingly.
b) We should probably distribute .be/id-cache to avoid scaring users
right off the bat ;). I've adjusted release.py accordingly.
c) We're falling behind on NEWS. Remember to make NEWS entries when
you make UI changes.
d) test_upgrade.py hasn't been updated since the Bazaar->Git
migration, so it currently fails in the source repo. However,
it requires the project history to function, so it will never
work with a release tarball. I suggest we remove it from the
release to avoid confusing users.
e) I just fixed a bug with `be show --xml` from the Bzr->Git migration
and another with `be diff` for Darcs 2.5. I discovered them by
running ./test_usage.sh which we've obviously not run in a while
;).
Trevor
--
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
pgppxbxdBXRRH.pgp
Description: PGP signature
_______________________________________________ Be-devel mailing list [email protected] http://void.printf.net/cgi-bin/mailman/listinfo/be-devel
