[merge] various developer process docs
Michael Hudson
michael.hudson at canonical.com
Sat Jun 7 10:49:14 BST 2008
John Arbash Meinel wrote:
> John Arbash Meinel has voted tweak.
> Status is now: Conditionally approved
> Comment:
> +Automatically-generated API reference information is available at
> +<http://bazaar-vcs.org/BzrLib>. See also the `Essential Domain Classes`_
> +section of this guide.
>
> ^- this is not true, BzrLib redirects to Documentation, and
> http://starship.python.net/crew/mwh/bzrlibapi/
>
> Is the auto-generated docs.
This mention reminded me to update the version of pydoctor that
generates these docs. The main difference that affects bzrlib is the
de-emphasizing of _private names -- have a look around and see what you
think.
I've also spent a little while fiddling to get the 'editing' version of
pydoctor working behind apache, and chucked an instance up here:
http://starship.python.net/crew/mwh/bzrlibapi-oe/
If you browse this version of the documentation, it should look almost
the same as the version linked to above -- but by each docstring there
is an 'Edit' button that let's you, well, edit the docstring. You can
also see the list of all changes made and get a diff containing them and
so on. Please, kick the tires and see what you think -- I guess even if
useful edits get made they won't be suitable for submission to Bazaar
for copyright reasons -- and let me know of any problems you find or
feature ideas you have.
Cheers,
mwh
More information about the bazaar
mailing list