[sage-devel] Re: verifying visual look of ReST in docstrings

[John H Palmieri]

On Aug 24, 8:48 am, David Kohel  wrote:
> I would prefer to generate a html or pdf file that I could view with
> standard tools or just read as plain text.   Or maybe break the
> task into steps: extract the doc strings to a ReST file, and browse
> the ReST file with some "standard tools" (say rst2html file |
> lynx).

Take a look at this:



It doesn't quite do what you want because it only works within a
running version of Sage.  But maybe it's some progress.

Regards,
  John

--~--~-~--~~~---~--~~
To post to this group, send an email to sage-devel@googlegroups.com
To unsubscribe from this group, send an email to 
sage-devel-unsubscr...@googlegroups.com
For more options, visit this group at http://groups.google.com/group/sage-devel
URLs: http://www.sagemath.org
-~--~~~~--~~--~--~---

[sage-devel] Re: verifying visual look of ReST in docstrings

[David Kohel]

I would prefer to generate a html or pdf file that I could view with
standard tools or just read as plain text.   Or maybe break the
task into steps: extract the doc strings to a ReST file, and browse
the ReST file with some "standard tools" (say rst2html file |
lynx).

The first step is important since I'd like to look at and compare
valid ReST extracted from the source files, e.g. identified from
good examples  in the manual.

If I want to learn ReST, then I would like to have some standard
tool (as simple as pdflatex file.tex + my_favorite_pdf_viewer) so
that I could view and validate a ReST file that I attempt to write.
So I find the second step important.

--David


--~--~-~--~~~---~--~~
To post to this group, send an email to sage-devel@googlegroups.com
To unsubscribe from this group, send an email to 
sage-devel-unsubscr...@googlegroups.com
For more options, visit this group at http://groups.google.com/group/sage-devel
URLs: http://www.sagemath.org
-~--~~~~--~~--~--~---

[sage-devel] Re: verifying visual look of ReST in docstrings

[William Stein]

On Mon, Aug 24, 2009 at 7:27 AM, David Kohel  wrote:

>
> Hi William,
>
> Thanks (to John Palmieri et al), such a feature was requested at Sage
> Days 16.
>
> Is there an interface in the command-line version or a command-line
> call on a file
> that doesn't request require starting up Sage?


I think so, in the sense that testing/build the reference manual has been
discussed numerous times before on sage-devel.

But the code I mentioned above is only for the notebook.  I can't really
imagine how it would work without the notebook, since it is code for
rendering ReST which partly requires javascript libraries, etc.   Do you
want something on the command line that pops up a web browser view of ReST?
Or pdf?  or ?

William

--~--~-~--~~~---~--~~
To post to this group, send an email to sage-devel@googlegroups.com
To unsubscribe from this group, send an email to 
sage-devel-unsubscr...@googlegroups.com
For more options, visit this group at http://groups.google.com/group/sage-devel
URLs: http://www.sagemath.org
-~--~~~~--~~--~--~---

[sage-devel] Re: verifying visual look of ReST in docstrings

[David Kohel]

Hi William,

Thanks (to John Palmieri et al), such a feature was requested at Sage
Days 16.

Is there an interface in the command-line version or a command-line
call on a file
that doesn't request require starting up Sage?

Cheers,

David

--~--~-~--~~~---~--~~
To post to this group, send an email to sage-devel@googlegroups.com
To unsubscribe from this group, send an email to 
sage-devel-unsubscr...@googlegroups.com
For more options, visit this group at http://groups.google.com/group/sage-devel
URLs: http://www.sagemath.org
-~--~~~~--~~--~--~---

[sage-devel] Re: verifying visual look of ReST in docstrings

[Golam Mortuza Hossain]

On Sun, Aug 23, 2009 at 4:46 PM, William Stein wrote:
>
> Thanks for finding this bug.  Can you report it to trac, please?

Here it goes

http://trac.sagemath.org/sage_trac/ticket/6815


Cheers,

--~--~-~--~~~---~--~~
To post to this group, send an email to sage-devel@googlegroups.com
To unsubscribe from this group, send an email to 
sage-devel-unsubscr...@googlegroups.com
For more options, visit this group at http://groups.google.com/group/sage-devel
URLs: http://www.sagemath.org
-~--~~~~--~~--~--~---

[sage-devel] Re: verifying visual look of ReST in docstrings

[William Stein]

On Sun, Aug 23, 2009 at 3:24 AM, Golam Mortuza Hossain
wrote:

>
> Hi,
>
> On Sun, Aug 23, 2009 at 2:02 AM, William Stein wrote:
>
> > If you did "sage -br" you do *not* have to restart the notebook server --
> > it suffices to just do "Action --> Restart Worksheet".
>
>
> Thats a cool feature.  I noticed that restarting worksheet seems to disable
> latex typesetting even though "Typeset" box is checked.  I need to
> un-check and then re-check the "Typeset" box to get it working again.
>

Thanks for finding this bug.  Can you report it to trac, please?

William

--~--~-~--~~~---~--~~
To post to this group, send an email to sage-devel@googlegroups.com
To unsubscribe from this group, send an email to 
sage-devel-unsubscr...@googlegroups.com
For more options, visit this group at http://groups.google.com/group/sage-devel
URLs: http://www.sagemath.org
-~--~~~~--~~--~--~---

[sage-devel] Re: verifying visual look of ReST in docstrings

[Golam Mortuza Hossain]

Hi,

On Sun, Aug 23, 2009 at 2:02 AM, William Stein wrote:

> If you did "sage -br" you do *not* have to restart the notebook server --
> it suffices to just do "Action --> Restart Worksheet".


Thats a cool feature.  I noticed that restarting worksheet seems to disable
latex typesetting even though "Typeset" box is checked.  I need to
un-check and then re-check the "Typeset" box to get it working again.


Cheers,
Golam

--~--~-~--~~~---~--~~
To post to this group, send an email to sage-devel@googlegroups.com
To unsubscribe from this group, send an email to 
sage-devel-unsubscr...@googlegroups.com
For more options, visit this group at http://groups.google.com/group/sage-devel
URLs: http://www.sagemath.org
-~--~~~~--~~--~--~---