Ticket #11263: trac_11263-doctests_link_all-fh.patch

File trac_11263-doctests_link_all-fh.patch, 1.5 KB (added by hivert, 10 years ago)
  • doc/en/developer/conventions.rst

    # HG changeset patch
    # User Florent Hivert <Florent.Hivert@univ-rouen.fr>
    # Date 1304445249 -7200
    # Node ID ecbf02aa5cebafaaade970914460c69e46c88b6e
    # Parent  543896a601185d677e6040f704c33ca0e3368cfa
    #11263: add ``.. linkall`` for doctests and fix devguide.
    
    diff --git a/doc/en/developer/conventions.rst b/doc/en/developer/conventions.rst
    a b and ``.sage`` files. 
    865865
    866866Of course in ReST files, one often inserts explanatory texts between
    867867different verbatim environments. To link together verbatim
    868 environments, use the ``.. link::`` comment. For example::
     868environments, use the ``.. link`` comment. For example::
    869869
    870870    ::
    871871
    environments, use the ``.. link::`` comm 
    874874
    875875    Next we add 1 to ``a``.
    876876
    877     .. link::
     877    .. link
    878878
    879879    ::
    880880
    881881            sage: 1 + a
    882882            2
    883883
    884 You can also put ``.. skip::`` right before a verbatim environment to
     884If you want to link all the verbatim environments together, you can put a
     885``.. linkall`` anywhere in the file. ``sage -t`` will act as if there were a
     886``.. link`` before each verbatim environments.
     887
     888You can also put ``.. skip`` right before a verbatim environment to
    885889have that example skipped when testing the file.  This goes right in
    886 the same place as the ``.. link::`` in the previous example.
     890the same place as the ``.. link`` in the previous example.
    887891
    888892See the files in ``SAGE_ROOT/devel/sage/doc/en/tutorial/`` for many
    889893examples of how to include automated testing in ReST documentation