#6820: [with patch, needs review] browse sage docs
-------------------------------+--------------------------------------------
Reporter: jhpalmieri | Owner: tba
Type: enhancement | Status: needs_review
Priority: minor | Milestone: sage-4.2.1
Component: documentation | Keywords: documentation
Work_issues: | Author: John Palmieri
Reviewer: mpatel, cremona | 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.
New: following cremona's suggestion, this also adds the following top-
level commands:
{{{
tutorial()
reference()
manual() # synonym for "reference"
developer()
constructions()
}}}
These open the corresponding document. The new command {{{python_help}}}
does what the old command {{{help}}} did. The new command help does the
following: with an argument, it acts like the old help -- that is, it
calls {{{python_help(arg)}}}. With no argument, it prints this message:
{{{
Welcome to Sage %s! To view the Sage tutorial in your web browser,
type 'tutorial()', and to view the (very detailed) Sage reference
manual, type 'manual()'. For help on any Sage function, for example
'matrix_plot', type 'matrix_plot?' to see a help message, type
'help(matrix_plot)' to see a very similar message, type
'browse_sage_doc(matrix_plot)' to view a message in a web browser, and
type 'matrix_plot??' to look at the function's source code.
To enter Python's interactive online help utility, type 'python_help()'.
To get help on a Python function, module or package, type 'help(MODULE)'
or
'python_help(MODULE)'.
}}}
(with the "%s" in the first line replaced by the version number).
--
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/6820#comment:14>
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
-~----------~----~----~----~------~----~------~--~---
