Specifying targets for intersphinx links to numpy, scipy, and matplotlib

后端 未结 4 707
谎友^
谎友^ 2021-02-02 05:03

Following the documentation for setting up Sphinx documentation links between packages, I have added

intersphinx_mapping = {\'python\': (\'http://docs.python.or         


        
4条回答
  •  执念已碎
    2021-02-02 05:50

    An additional way to know how to do cross reference is with the sphobjinv module.

    You can search local or even remote inventory files (with fuzzy matching). For instance with scipy:

    $ sphobjinv suggest -t 90 -u https://docs.scipy.org/doc/scipy/reference/objects.inv "signal.convolve2d"
    
    Remote inventory found.
    
    :py:function:`scipy.signal.convolve2d`
    :std:doc:`generated/scipy.signal.convolve2d`
    

    Note that you may need to use :py:func: and not :py:function: (I'd be happy to know why).

提交回复
热议问题