API docs for bzrlib, generated by pydoctor.

Alexander Belchenko bialix at ukr.net
Mon Feb 19 17:47:11 GMT 2007


-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Andrew Bennetts пишет:
> Hi all,
> 
> I've put up some API docs for bzrlib:
> 
>     http://people.ubuntu.com/~andrew/bzr-apidocs/
> 
> They're generated by pydoctor <http://codespeak.net/~mwh/pydoctor/>.  Pydoctor
> expects epydoc markup (or at least claims to).  I generated them against current
> bzr.dev, rather than any particular release.
> 
> I thought this might be helpful to people that want to explore the bzrlib API.
> I was also curious to see how good a job a tool like pydoctor can do with our
> existing docstrings and conventions.
> 
> For reference, I used current SVN pydoctor, with the following command line:
> 
>     pydoctor --docformat="restructuredtext" --make-html --add-package=bzrlib ./bzrlib/
> 
> There's a bunch of options to pydoctor I haven't explored that could perhaps
> improve the output.
> 
> I've also put a tarball of all the generated HTML online, in case you'd like to
> grab an offline copy:
> 
>     http://people.ubuntu.com/~andrew/bzr-api.tar.bz2
> 
> Enjoy!

Good work!
Thank you very much.

- --
Alexander
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.6 (MingW32)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org

iD8DBQFF2eKfzYr338mxwCURAmCzAJ4m7PpyqjKez0C7tWynbnlLcFLsOgCfTgKQ
YQt3OWV39Pre860ZEI4ZTO4=
=cBVm
-----END PGP SIGNATURE-----




More information about the bazaar mailing list