[Grok-dev] Linking to the Grok Documentation

[Sylvain Viollon]

On Thu, 25 Nov 2010 19:18:37 +0100
Sebastian Ware <sebastian at urbantalk.se> wrote:

  Hello,

> Sylvain, are you aware of sphinx.ext.intersphinx? It should handle
> external references for you and be more robust in case things get
> moved around.
> 
> This is what we found one could do:
> 
> """
> Add sphinx.ext.intersphinx to conf.py...
> 
>  extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest',
> 'sphinx.ext.todo', 'sphinx.ext.intersphinx']
> 
> ...and add the reference to the objects.inv...
> 
>   intersphinx_mapping = {
>       'grok': ('http://grok.zope.org/doc/1.2.1', None),
>       }
> 
> Find links that can be refered to:
> 
>  http://grok.zope.org/doc/1.2.1/objects.inv
> 
> By using the following markup:
> 
>  :py:class:`Hello <grok.LocalUtility>`
> """
> 

  That sound interesting, I will test it.

  Thanks for the tip,

  Sylvain,



-- 
Sylvain Viollon -- Infrae
t +31 10 243 7051 -- http://infrae.com
Hoevestraat 10 3033GC Rotterdam -- The Netherlands