Browseable documentation

Bug #489156 reported by Jonathan Lange
10
This bug affects 2 people
Affects Status Importance Assigned to Milestone
testtools
Fix Released
Wishlist
Jonathan Lange

Bug Description

testtools has fairly good documentation. It would be nice to be able to view this documentation on the web, perhaps in a form not entirely unlike docs.python.org (generated by Sphinx).

Revision history for this message
Robert Collins (lifeless) wrote :

Do you mean MANUAL? If so, that would be nice, though I'd like to get more of it into the API docs and make those really consistent.

Revision history for this message
Cory Dodt (corydodt) wrote :

Really just any kind of doc linked anywhere. Can you provide a link to the source-controlled files that contain documentation? I see nothing on the launchpad page for the project that tells me why I should even be interested..

Revision history for this message
Robert Collins (lifeless) wrote : Re: [Bug 489156] Re: Browseable documentation

On Wed, 2009-12-16 at 00:08 +0000, Cory Dodt wrote:
> Really just any kind of doc linked anywhere. Can you provide a link to
> the source-controlled files that contain documentation? I see nothing
> on the launchpad page for the project that tells me why I should even be
> interested..

Sure; I can't edit the lp metadata (jml, perhaps its time to loosen
those reins too :P), but I can point you at things.

Firstly, if you install python-testtools, pydoc testtools will give you
a bunch of info.

Secondly, in the source (or if you install the debian package,
in /usr/share/python-testtools), README and MANUAL are good sources of
information.

Online you can access those files at
http://bazaar.launchpad.net/~testtools-dev/testtools/trunk/annotate/head
%3A/README
and
http://bazaar.launchpad.net/~testtools-dev/testtools/trunk/annotate/head
%3A/MANUAL

Cheers,
Rob

Changed in testtools:
status: Confirmed → Triaged
Revision history for this message
Jonathan Lange (jml) wrote :

We have the manual on PyPI and the API docs linked from the Launchpad page. I'm going to mark this ticket as Fix Released. Please open newer, more specific bugs for any things that we can improve on.

Changed in testtools:
status: Triaged → Fix Released
assignee: nobody → Jonathan Lange (jml)
milestone: none → next
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.