#10637: Implement sage -sws2rst
------------------------------------------------------------+---------------
Reporter: nthiery | Owner:
jason, mpatel, was
Type: enhancement | Status:
needs_review
Priority: major | Milestone:
sage-5.9
Component: notebook | Resolution:
Keywords: ReST, worksheet | Work issues:
Report Upstream: Workaround found; Bug reported upstream. | Reviewers:
Nicolas Thiéry, Jason Grout, Karl-Dieter Crisman, Jason Bandlow, John Palmieri,
Simon King
Authors: Pablo Angulo, Karl-Dieter Crisman | Merged in:
Dependencies: | Stopgaps:
------------------------------------------------------------+---------------
Changes (by kcrisman):
* cc: jdemeyer (added)
* dependencies: #11080, #11459 =>
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 {{{spkg/bin/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]. (To release manager: this would need to be moved to the optional
> spkg directory.)
> * Apply [attachment:trac_10637-root.patch] to the root repository
> * Apply [attachment:trac_10637-scripts.patch] and [attachment:trac_10637
> -scripts-docsandmore.patch] to the scripts repository
>
> * Apply [attachment:tools_sws2rst_4.patch], [attachment:trac_10637
> -sagenb-reviewer.patch], and
> [attachment:trac_10637_answer_to_kcrisman.patch] to sagenb, possibly
> followed by
> {{{
> 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 {{{spkg/bin/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]. (To release manager: this would need to be moved to the optional
spkg directory.)
* Apply [attachment:trac_10637-root.patch] to the root repository
* Apply [attachment:trac_10637-scripts.patch] and [attachment:trac_10637
-scripts-docsandmore.patch] to the scripts repository
* Apply [attachment:tools_sws2rst_4.patch], [attachment:trac_10637
-sagenb-reviewer.patch], [attachment:trac_10637_answer_to_kcrisman.patch],
and [attachment:trac_10637-second-review.patch] to sagenb, possibly
followed by
{{{
sage -python setup.py install && sage -python setup.py develop
}}}
--
Comment:
Okay, for full review I suppose it would be nice for
* Pablo to confirm that br tag is okay now ''or'' for someone (could be
me) to try some worksheets with that to test
* Jeroen or someone else who knows their way around spkg/bin/sage to make
sure the update to the root patch is ok even though the exit etc. is gone
(but it seems to be gone from the others as well)
Keshav, the pull requests are updated, so please don't release the next
sagenb until this is done.
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/10637#comment:131>
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 http://groups.google.com/group/sage-trac?hl=en.
For more options, visit https://groups.google.com/groups/opt_out.
