#10637: Implement sage -sws2rst
-------------------------------------------------------+--------------------
       Reporter:  nthiery                              |         Owner:  jason, 
mpatel, was                                                                  
           Type:  enhancement                          |        Status:  
needs_review                                                                    
    
       Priority:  major                                |     Milestone:  
sage-5.1                                                                        
    
      Component:  notebook                             |    Resolution:         
                                                                             
       Keywords:  ReST, worksheet                      |   Work issues:         
                                                                             
Report Upstream:  Reported upstream. No feedback yet.  |     Reviewers:  
Nicolas Thiéry, Jason Grout, Karl-Dieter Crisman, Jason Bandlow, Karl-Dieter 
Crisman
        Authors:  Pablo Angulo                         |     Merged in:         
                                                                             
   Dependencies:  #11080                               |      Stopgaps:         
                                                                             
-------------------------------------------------------+--------------------
Changes (by kcrisman):

  * status:  needs_work => needs_review
  * reviewer:  Nicolas Thiéry, Jason Grout, Karl-Dieter Crisman, Jason
               Bandlow => Nicolas Thiéry, Jason Grout, Karl-
               Dieter Crisman, Jason Bandlow, Karl-Dieter
               Crisman


Old description:

> Implement:
>
> {{{
>     sage -sws2rst bla.sws bli.sws ...
> }}}
>
> which given worksheets
>
> {{{bla.sws, bli.sws, ...}}} would create ReST files {{{bla.rst, bli.rst,
> ...}}} together with media directories:
>
> {{{
> media/bla/
> media/bla/data/
> media/bla/7/sage0.png
> ...
> media/bli/
> ...
> }}}
>
> The proposed implementation adds a script
> {{{local/bin/sage-sws2rst}}}, edits {{{local/bin/sage-sage}}} to add
> the sws2rst option, and add some libraries in
> {{{sagenb-main/sagenb/notebook/}}}. It further depends on the
> BeautifulSoup Python library (released under Python's license).
>
> The script builds the ReST file from the worksheet.html file included in
> the .sws as follow:
>
>  - Preparsing to handle the input / output fields
>  - Parsing of the resulting html using BeautifulSoup
>  - Manipulation on the obtained tree
>
> Suggestions for better file layout or implementation welcome!
>
> Edit:
> == Install instructions ==
>
>  * Install the beautifulsoup spkg
> [http://sage.math.washington.edu/home/kcrisman/beautifulsoup-3.2.1.spkg
> here]
>
>  * A first patch (add_sws2rst_4.patch) adds the sage-sws2rst script, and
> it must be imported on the local/bin dir
>
>  * A second patch (tools_sws2rst_4.patch) sends three files to
> sagenb/misc and it must be imported on the devel/sagenb dir, and followed
> by a
>
> {{{
>     sage -python setup.py install && sage -python setup.py develop
> }}}

New description:

 Implement:

 {{{
     sage -sws2rst bla.sws bli.sws ...
 }}}

 which given worksheets

 {{{bla.sws, bli.sws, ...}}} would create ReST files {{{bla.rst, bli.rst,
 ...}}} together with media directories:

 {{{
 media/bla/
 media/bla/data/
 media/bla/7/sage0.png
 ...
 media/bli/
 ...
 }}}

 The proposed implementation adds a script
 {{{local/bin/sage-sws2rst}}}, edits {{{local/bin/sage-sage}}} to add
 the sws2rst option, and add some libraries in
 {{{sagenb-main/sagenb/notebook/}}}. It further depends on the
 BeautifulSoup Python library (released under Python's license).

 The script builds the ReST file from the worksheet.html file included in
 the .sws as follow:

  - Preparsing to handle the input / output fields
  - Parsing of the resulting html using BeautifulSoup
  - Manipulation on the obtained tree

 Suggestions for better file layout or implementation welcome!

 == Install instructions ==

  * Install the beautifulsoup spkg
 [http://sage.math.washington.edu/home/kcrisman/beautifulsoup-3.2.1.spkg
 here]
  * Apply [attachment:trac_10637-root.patch] to the root repository
  * Apply [attachment:trac_10637-scripts.patc] to the scripts repository

  * Apply [attachment:tools_sws2rst_4.patch] to sagenb, possibly followed
 by
 {{{
     sage -python setup.py install && sage -python setup.py develop
 }}}

--

-- 
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/10637#comment:36>
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