I found that you need to list the project in the "intersphinx_mapping"
section of conf.py, eg:
intersphinx_mapping = {
'pymongo': ('http://api.mongodb.org/python/current/', None),
'python' : ('http://docs.python.org/', None),
'django': ('https://django.readthedocs.org/en/latest/', None),
'djangomongodbengine': ('http://django-mongodb.org/', None),
'djangotoolbox' :
('http://djangotoolbox.readthedocs.org/en/latest/', None),
}
where the label (eg, pymongo, python, djangotoolbox) is what you write in
your documentation, eg:
:py:meth:`db.events.ensure_index() <*pymongo*
:pymongo.collection.Collection.ensure_index>`
So you could add something like:
intersphinx_mapping = {
'api' : ('http://api.example.com', None)
}
to your conf.py and use "api" in your refs.
You need to use a link target which is defined in the target's objects.inv
file (sphinx will try to load http://api.example.com/objects.inv unless you
specify a file in the intersphinx_mapping).
--
-ed costello
--
You received this message because you are subscribed to the Google Groups
"sphinx-dev" group.
To view this discussion on the web visit
https://groups.google.com/d/msg/sphinx-dev/-/mO-6RU5nGeUJ.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/sphinx-dev?hl=en.
