Ticket #11263: trac_11263-second.patch

File trac_11263-second.patch, 2.4 KB (added by jhpalmieri, 10 years ago)

apply on top of trac_11263-doctests_link_all-fh.patch

  • doc/en/developer/conventions.rst

    # HG changeset patch
    # User J. H. Palmieri <palmieri@math.washington.edu>
    # Date 1304448621 25200
    # Node ID fe1695ce44d965db8a5bd645c4824a063933a6c8
    # Parent  e3adfff0a7a838976d5231de6cfe3b825da673fc
    #11263: reword the changes to the developer's guide
    also add an example of ".. linkall"
    
    diff --git a/doc/en/developer/conventions.rst b/doc/en/developer/conventions.rst
    a b environments, use the ``.. link`` commen 
    867867            sage: 1 + a
    868868            2
    869869
    870 If you want to link all the verbatim environments together, you can put a
    871 ``.. linkall`` anywhere in the file. ``sage -t`` will act as if there were a
    872 ``.. link`` before each verbatim environments.
     870If you want to link all the verbatim environments together, you can
     871put ``.. linkall`` anywhere in the file, on a line by itself.  (For
     872clarity, it might be best to put it near the top of the file.)  Then
     873``sage -t`` will act as if there were a ``.. link`` before each
     874verbatim environment.  The file
     875``SAGE_ROOT/devel/sage/doc/en/tutorial/interfaces.rst`` contains a
     876``.. linkall`` directive, for example.
    873877
    874878You can also put ``.. skip`` right before a verbatim environment to
    875 have that example skipped when testing the file.  This goes right in
     879have that example skipped when testing the file.  This goes in
    876880the same place as the ``.. link`` in the previous example.
    877881
    878882See the files in ``SAGE_ROOT/devel/sage/doc/en/tutorial/`` for many
  • doc/en/tutorial/interfaces.rst

    diff --git a/doc/en/tutorial/interfaces.rst b/doc/en/tutorial/interfaces.rst
    a b  
     1.. linkall
     2
    13**********
    24Interfaces
    35**********
    Every PARI object is of type ``py_pari.g 
    104106underlying object can be obtained using the ``type`` member
    105107function.
    106108
    107 .. link
    108 
    109109::
    110110
    111111    sage: v.type()
    In PARI, to create an elliptic curve we  
    116116method that can be called on any PARI object, e.g., our
    117117``t\_VEC v``.
    118118
    119 .. link
    120 
    121119::
    122120
    123121    sage: e = v.ellinit()
    method that can be called on any PARI ob 
    129127Now that we have an elliptic curve object, we can compute some
    130128things about it.
    131129
    132 .. link
    133 
    134130::
    135131
    136132    sage: e.elltors()
    Singular (do not type the ``...``): 
    216212
    217213Now that we have defined :math:`f`, we print it and factor.
    218214
    219 .. link
    220 
    221215::
    222216
    223217    sage: f