#13064: The documentation should search methods in classes
------------------------------------+---------------------------------------
       Reporter:  ppurka            |         Owner:  mvngu       
           Type:  defect            |        Status:  needs_review
       Priority:  major             |     Milestone:  sage-5.6    
      Component:  documentation     |    Resolution:              
       Keywords:  documentation     |   Work issues:              
Report Upstream:  N/A               |     Reviewers:              
        Authors:  Travis Scrimshaw  |     Merged in:              
   Dependencies:                    |      Stopgaps:              
------------------------------------+---------------------------------------

Comment (by jhpalmieri):

 Here's a sample patch. This changes Sage so it uses its own "search.html"
 page instead of the default one. The difference between the default one
 and the one in the patch is this:
 {{{
 #!diff
 --- local/lib/python/site-
 packages/Sphinx-1.1.2-py2.7.egg/sphinx/themes/basic/search.html
 2012-11-17 10:34:58.000000000 -0800
 +++ devel/sage/doc/common/themes/sage/search.html       2012-11-17
 22:11:12.000000000 -0800
 @@ -31,6 +31,12 @@
      function will automatically search for all of the words. Pages
      containing fewer words won't appear in the result list.{% endtrans %}
    </p>
 +  <p>
 +    {% trans %}Note also that you can also call "search_src(...)"
 +    while running Sage to search Sage's source code. You can also
 +    browse Sage's source code by calling "hg_sage.serve()" while running
 +    Sage.{% endtrans %}
 +  </p>
    <form action="" method="get">
      <input type="text" name="q" value="" />
      <input type="submit" value="{{ _('search') }}" />
 }}}

-- 
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/13064#comment:11>
Sage <http://www.sagemath.org>
Sage: Creating a Viable Open Source Alternative to Magma, Maple, Mathematica, 
and MATLAB

-- 
You received this message because you are subscribed to the Google Groups 
"sage-trac" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to 
[email protected].
For more options, visit this group at 
http://groups.google.com/group/sage-trac?hl=en.

Reply via email to