#6820: [with patch, needs review] browse sage docs
---------------------------+------------------------------------------------
Reporter: jhpalmieri | Owner: tba
Type: enhancement | Status: new
Priority: minor | Milestone: sage-4.1.2
Component: documentation | Keywords:
Reviewer: | Author: John Palmieri
Merged: |
---------------------------+------------------------------------------------
Description changed by jhpalmieri:
Old description:
> The attached patch introduces the command {{{browse_sage_doc}}}. It lets
> you do the following from either the command-line or the notebook:
> {{{
> browse_sage_doc.tutorial() # open the tutorial in a browser window
> browse_sage_doc.reference()
> browse_sage_doc.developer()
> browse_sage_doc.constructions()
> }}}
> and also
> {{{
> browse_sage_doc(identity_matrix)
> }}}
> opens up the docstring for {{{identity_matrix}}} in a browser window. It
> doesn't look very pretty, but it's legible. You can also do
> {{{
> browse_sage_doc(identity_matrix, output='rst)
> }}}
> to output (as a string) the reST version of the docstring, and
> {{{
> browse_sage_doc(identity_matrix, view=False)
> }}}
> to output (as a string) the html version of the docstring
New description:
The attached patch introduces the command {{{browse_sage_doc}}}. It lets
you do the following from either the command-line or the notebook:
{{{
browse_sage_doc.tutorial() # open the tutorial in a browser window
browse_sage_doc.reference()
browse_sage_doc.developer()
browse_sage_doc.constructions()
}}}
and also
{{{
browse_sage_doc(identity_matrix)
}}}
opens up the docstring for {{{identity_matrix}}} in a browser window. It
doesn't look very pretty, but it's legible. You can also do
{{{
browse_sage_doc(identity_matrix, output='rst')
}}}
to output (as a string) the reST version of the docstring, and
{{{
browse_sage_doc(identity_matrix, view=False)
}}}
to output (as a string) the html version of the docstring
--
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/6820#comment:1>
Sage <http://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
-~----------~----~----~----~------~----~------~--~---
