On Jan 16, 1:14 am, Florent Hivert <florent.hiv...@univ-rouen.fr>
wrote:
>       Hi John,

> It seems that doesn't work inside a note environement:

I guess it doesn't interact well with other environments? As far as I
know, the ".. link" directive is a Sage add-on, dealt with in
SAGE_ROOT/local/bin/sage-doctest, and it may not be implemented as
fully as one might like.  Another way of looking at this is, perhaps
you should only be able to link blocks which are at the same level of
indentation, so maybe this is a feature, not a bug :)

> Another remark:

> In conventions.html#testing-rest-documentation you write
>
> """
> environments, use the ``.. link::`` comment.

> Whereas for example in tutorial/interface.rst you have a bunch of
>
> """
> .. link
>
> ::
> """
>
> without "::" after link. Moreover if you put a :: things seems to works
> correctly but sphinx issues a
>
> """
> /home/florent/src/Sage/sage/devel/sage/doc/en/reference/demos/tutorial-obje 
> cts-and-classes.rst:56: (ERROR/3) Unknown directive type "link".
>
> .. link::
> """
>
> Should we correct the dev-guide ? If yes as a punishment for not having fully
> read it, I'm ok to write a patch.

I think we should correct the dev guide (or patch Sphinx so it doesn't
give the warning).  The same might be true with

"""
.. skip

::
"""

vs.

"""
.. skip::
"""

If you have time to write patch for the documentation, and if you
could check "skip", that would be great.  Of course, cc me on any
ticket.

Thanks,
John

-- 
To post to this group, send an email to sage-devel@googlegroups.com
To unsubscribe from this group, send an email to 
sage-devel+unsubscr...@googlegroups.com
For more options, visit this group at http://groups.google.com/group/sage-devel
URL: http://www.sagemath.org

Reply via email to