[Twisted-Python] Lore to Sphinx Conversion Progress Report 6
Michael Hudson-Doyle
micahel at gmail.com
Thu Mar 4 19:10:19 EST 2010
On 5 March 2010 12:31, Kevin Horn <kevin.horn at gmail.com> wrote:
> On Thu, Mar 4, 2010 at 5:05 PM, <exarkun at twistedmatrix.com> wrote:
>>
>> On 10:49 pm, kevin.horn at gmail.com wrote:
>> >
>> > If you look up a class, like "twisted.internet.defer.Deferred" for
>> >example,
>> > the link looks like this:
>> >
>> >
>>
>> > >http://twistedmatrix.com/documents/current/api/twisted.internet.defer.Deferred.html
>> >
>> > Pretty simple right? But if you look up a function or method like
>> > "twisted.internet.defer.Deferred.callback", the link has an anchor,
>> >like
>> >so:
>> >
>> >
>>
>> > >http://twistedmatrix.com/documents/9.0.0/api/twisted.internet.defer.Deferred.html#addCallback
>> >
>> > So we'll need to do some checking on either the api docs or on twisted
>> >itself
>> > to determine what sort of object is being linked to. Shouldn't be
>> > super-difficult, just haven't had time yet.
>>
>> Did you notice that
>>
>> http://twistedmatrix.com/documents/9.0.0/api/twisted.internet.defer.Deferred.addCallback.html
>> also exists?
>>
>> Jean-Paul
>>
>
> I hadn't actually. If all functions and methods have a similar page in the
> PyDoctor output, then I think what I have now will pretty much work as-is
> (almost). Do we think that just generating links to the individual
> function/method pages is acceptable?
It's what the lore-processed documentation currently links to. It
would be nice to fix this (and I sort of vaguely know how), but that
should in no way hold up the move away from lore!
Cheers,
mwh
More information about the Twisted-Python
mailing list