Support linking to interlinks objects.inv

Bug #1318325 reported by Adi Roiban on 2014-05-11
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
pydoctor
Fix Committed
Undecided
Adi Roiban

Bug Description

When a link is unresolved, pydoctor could look into sphinx object inventory mapping and try to get a valid link.

intersphinx_mapping = {
      'Crypto' : ('http://py.crypto.com/api', None),
      'twisted: ('http://tm.tld/documentation/current/api', 'index.inv'),
      }

For unresolved L{Crypto.something} it will check the http://py.crypto.com/api/objects.inv file

For unresolved L{twisted.something} it will check the http://tm.tld/documentation/current/api/index.inv file

----------

Since pydoctor only has simple configuration file... and does not support python code for configuration... the intershinx configuration could look like

--intersphinx Crypto:http://py.crypto.com/api/objects.inv
--intersphinx twisted:http://tm.tld/docs/api/index.inv

Related branches

Adi Roiban (adiroiban) on 2014-05-11
Changed in pydoctor:
assignee: nobody → Adi Roiban (adiroiban)
Changed in pydoctor:
status: New → Fix Committed
To post a comment you must log in.
This report contains Public information  Edit
Everyone can see this information.

Other bug subscribers