[Grok-dev] Linking to the Grok Documentation

Sylvain Viollon sylvain at infrae.com
Fri Nov 26 05:05:52 EST 2010


On Fri, 26 Nov 2010 11:03:24 +0100
Uli Fouquet <uli at gnufix.de> wrote:

> Hi there,
> 
> Yep, it's pretty useful. You can add links to current Python standard
> lib docs like this::
> 
>   intersphinx_mapping = {
>         'python': ('http://docs.python.org/', None),
>       }
> 
> or like this, if you prefer to reference a certain version of Python::
> 
>   intersphinx_mapping = {
>         # reference Python 2.6 docs...
>         'python26blah': ('http://docs.python.org/release/2.6.6/',
> None), # reference also grok...
>         'grok': ('http://grok.zope.org/doc/1.2.1', None),
>         # add more external docs here...
>       }
> 
> and some ReST construct like::
> 
>   The :class:`grok.LocalUtility` does not 
>   accept :class:`StringIO.StringIO` instances.
> 
> should then automatically link to the appropriate docs. Generally you
> can link to any package that is hosted on some site and provides
> Sphinx docs with some objects.inv file.
> 
> Please note that by default you can leave out the :py: domain marker
> for Python objects/functions/methods, i.e. you can still
> write :class:`blah` instead of :py:class:`blah` because Python is the
> default domain. See
> 
>   http://sphinx.pocoo.org/latest/domains.html
> 
> to learn more about Sphinx domains.
> 
> Another thing: what about uploading the reference docs for certain
> versions of Grok Toolkit to packages.python.org/grok? I think this
> place (packages.python.org) could become the default for reference
> docs of Python packages in the long run. Only thing is: being
> splitted up into grokcore.x packages, I am not sure about whether
> 'the' grok package will live forever.
> 

  That would be great, as actually I only use the grokcore stuff, ad
  the Grok itself. There is slight differences, like, no
  ``application_url``.

  I know about domains, I added interface and event to it.

  Regards,

  Sylvain,


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


More information about the Grok-dev mailing list