Code review comment for lp:~adiroiban/pydoctor/1318325-intersphinx

Revision history for this message
Adi Roiban (adiroiban) wrote :

Appending objects.inv could be added later :) ... this is a tool for developers and I assume all command arguments are only written once and then integrated into the build system.

I prefer to have explicit settings and know what URL is used.

-------

b) ... ok but then at least for stdlib we also need to configure if this is py2 or py3 ... maybe based on current python version.

I would leave this for a new ticket so that people start using the current code and then send some feedback.

Also, I see that pydoctor has a hack to load configuration options from a file... one workaround is to provide a sample

From my point of view intersphinx works in a similar way, as intershpinx does not arbitrary search all configured objects.inv

intersphinx_mapping = {
 'py2': ('http://docs.python.org/2.7', None),
 'py3': ('http://docs.python.org/3.2', None),
}

Adapted from documentation

A link like :ref:`comparison manual <py2:os.path>` will link to the label “os.path” in the doc set “py2”, if it exists.

To have a similar markup as intersphinx, we should need to use L{py2:os.path} instead of L{os.path}

I agree that for pydoctor this does not make sense and is ok to search whole list.

In this case --intersphinx http://url/to/objects.inv should be enough.

---

Maybe we can merge this branch is is and then have a new ticket to update code to look in all objects.inv and a new ticket to update stdlib links .... and see what to do with py2 vs py3 for stdlib.
..
Thanks!

« Back to merge proposal