Salgado has gotten the Zope apidoc to work to show Launchpad's code.  I think 
you all might find it useful.  I often have found the Zope-only version 
helpful, and this new version is custom to our own codebade.

People with access to devpad can just go to https://devpad.canonical.com/~gary 
to give it a whirl.

You can also add apidoc.launchpad.dev to your /etc/hosts, start up a recent 
branch of Launchpad, and visit apidoc.launchpad.dev.  (Note that this will not 
be available on staging, edge, or prod.)

Things to try:

- Click on the book link on the top left.  On the bottom left, look for the 
Launchpad section of the docs.  It has a few ReST docs that I knew were actual 
documentation.  It's easy to expose doctests like this, and I hope to 
eventually expose other docs, like the stuff from lazr.restful; if you want to 
add some docs here, let me know and I'll describe how to do it.  It's pretty 
easy.

- Click on the Interfaces link on the top left.  In the text box on the bottom 
left frame, type in ILaunchpadPermission.  Click on the link.  You'll see on 
the page an example of the information available--a hyperlinked description of 
the interface, the adapters registered for the interface, the registered 
utilities for that interface, the classes that implement the interface, and so 
on.

- Click on the zcml references link on the top left.  Click on a zcml tag in 
the bottom left frame, like our own zope:securedutility.  It will tell you what 
the attributes are for the tag, where it is defined and implemented, and what 
the subdirectives are.

- Click on the code browser link on the top left.  Click on the "browse source 
code" in the link on the bottom left frame, or type in a name and click "Find". 
 Start browsing around.  You'll see everything is interlinked as you browse.

This information is also recorded here: https://dev.launchpad.net/apidoc

Gary
_______________________________________________
Mailing list: https://launchpad.net/~launchpad-dev
Post to     : [email protected]
Unsubscribe : https://launchpad.net/~launchpad-dev
More help   : https://help.launchpad.net/ListHelp

Reply via email to