[Twisted-Python] Distributing apilinks.py

Adi Roiban adi at roiban.ro
Mon May 5 02:23:09 MDT 2014


Hi Tom,

Many, many thanks for pushing this forward!

IRequest.getSession.html and extlinks is a workaround, but I hope that
we can fix the source problem soon so that we don't have to stick with
the workaround for to long.

Is there a ticket in pydoctor for the generation of objects.inv ?

Michael, are you convinced that it would be nice for pydoctor to
generate objects.inv ?

I think that implementing this feature could help other project using
only sphinx for both narrative and api documentation.
I can try to send a patch for that.

Thanks!



On 5 May 2014 11:07, Tom Prince <tom.prince at ualberta.net> wrote:
> Eventually, apilinks should just go away. I think I have convinced
> Michael (pydoctor's maintainer) that pydoctor should just genereate an
> objects.inv that sphinx can read. Then the regular :py:*: annoations can
> be used, rather than the apilinks ones (which interpert <> backwards
> anyway).
>
> That doesn't address the issue of what to do in the mean time. Looking
> at the code, it looks very similar to what the builtin extlinks
> extension does; except that apilinks wants `path.to.object <title> and
> extlinks wants `title <path.to.object>`. (But I guess this doesn't
> address the issue of # in the links being put in the wrong place. But,
> https://twistedmatrix.com/documents/current/api/twisted.web.iweb.IRequest.getSession.html
> does exists (probably to make this kind of linking work.
>
>   Tom



-- 
Adi Roiban



More information about the Twisted-Python mailing list