[Grok-dev] Linking to the Grok Documentation

[Sebastian Ware]

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>`
"""

Mvh Sebastian


25 nov 2010 kl. 11.35 skrev Sylvain Viollon:

> Hello,
> 
>  I am currently writing documentation for Silva. I would like
>  to know if it is safe to link to the Official Grok Documentation,
>  like to
>  http://grok.zope.org/doc/current/reference/components.html#views
> 
>  Or is to called to change (like to be replaced by an UnOfficial Grok
>  Documentation) ?
> 
>  As good to know, I made some extensions to Sphinx, who are not
>  released yet:
> 
>  https://hg.infrae.com/sphinxcontrib.infrae/
> 
>  This contains a Pygment lexer for Buildout syntax (to get the line
>  number working), an autointerface and autoevent directive, based a
>  long time ago on repoze.sphinx.autointerface. I can tell you more
>  about it if you are interested on IRC.
> 
>  Sylvain.
> 
> -- 
> Sylvain Viollon -- Infrae
> t +31 10 243 7051 -- http://infrae.com
> Hoevestraat 10 3033GC Rotterdam -- The Netherlands
> _______________________________________________
> Grok-dev mailing list
> Grok-dev at zope.org
> https://mail.zope.org/mailman/listinfo/grok-dev