#85 example to reference to external API

v3.0
open
5
2008-05-16
2008-05-16
Cat slave
No

Hi all,

I'm just not quite sure where to post this question, sorry can't find the answer in FAQ or other...

I have multiple projects with each their own package. Let's imagine:
- http://my.api/project1
- http://my.api/project2

In project2, I have something like:

>>> from project1 import module1
>>> u"""
>>> ...
>>> @see: L{project1.module1<module1>}
>>> """

How would i make a epydoc @see: L{project1.module1} link to the external api?

I've tried:
epydoc ...
--external-api=project1
--external-api-file=/path/to/project1/api-objects.txt
--external-api-root=http://my.api/project1
project2

Maybe this can be clarified with an example in the FAQ or manual, or did I missed it?

Thanks in advance,
H.

Discussion


Log in to post a comment.