#20589: Add a link to the static documentation in Jupyter interactive help (?)
---------------------------+----------------------------
   Reporter:  nthiery      |            Owner:
       Type:  enhancement  |           Status:  new
   Priority:  major        |        Milestone:  sage-7.3
  Component:  notebook     |         Keywords:
  Merged in:               |          Authors:
  Reviewers:               |  Report Upstream:  N/A
Work issues:               |           Branch:
     Commit:               |     Dependencies:
   Stopgaps:               |
---------------------------+----------------------------
 Querying the documentation of an object/method in the Jupyter
 notebook, opens an help window. The goal of this ticket is to include
 a link to the corresponding Sphinx-compiled static documentation when
 it exists.

 Notes for potential implementation:

 The inventory objects obtained as side product of the Sphinx contains
 appropriate information to retrieve the relevant html file name, and
 the label is just the name of the object::

 {{{
 ...
 sage.combinat.composition.Compositions py:class 1
 sage/combinat/composition.html#$ -
 ...
 }}}

 So we just need to scan those, and know the base url of the static html
 documentation.

--
Ticket URL: <http://trac.sagemath.org/ticket/20589>
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 unsubscribe from this group and stop receiving emails from it, send an email 
to [email protected].
To post to this group, send email to [email protected].
Visit this group at https://groups.google.com/group/sage-trac.
For more options, visit https://groups.google.com/d/optout.

Reply via email to