doclinks

Creating the module index


NbdevLookup

 NbdevLookup (strip_libs=None, incl_libs=None, skip_mods=None)

Mapping from symbol names to URLs with docs

Symbol names are taken from libraries registered using the ‘nbdev’ entry point. By default, all libraries with this entry point are searched, but full symbol names (including module prefix) are required.

c = NbdevLookup()
assert c['nbdev.doclinks.DocLinks'].startswith('http')
assert c['numpy.array'].startswith('http')
assert c['DocLinks'].startswith('http')
assert not c['array']

Pass strip_libs to list libraries which should be available without requiring a module prefix.

c = NbdevLookup(strip_libs=['nbdev', 'nbdev_numpy'])
assert c['array'].startswith('http')
assert c['DocLinks'].startswith('http')

nbdev itself includes nbdev_lookup, an instantiated NbdevLookup with strip_libs=nbdev.

_nbdev_lookup = NbdevLookup()
assert _nbdev_lookup['DocLinks'].startswith('http')
assert _nbdev_lookup['numpy.array'].startswith('http')
assert not _nbdev_lookup['array']

Backticks


NbdevLookup.linkify

 NbdevLookup.linkify (md)

Footnotes

  1. _.↩︎

  2. _.↩︎