2009/4/16 John H Palmieri <jhpalmier...@gmail.com>:
>
>
>
> On Apr 16, 9:44 am, John Cremona <john.crem...@gmail.com> wrote:
>> Now I am getting the hang of this ReST/Sphinx stuff (this is very
>> useful:  http://docutils.sourceforge.net/docs/user/rst/quickref.htm)
>> I have some questions:
>>
>> * Sometimes stuff in between `...` does not get put into math mode.
>>
>> * When it does, not everything gets rendered properly (e.g. Greek
>> letters), but that might just be the fault of my browser's setup.
>
> Do you have examples (e.g., from the Sage library)? I'd like to take a
> look.

My examples were from new docstrings I was writing.  The guide you
refer to has just about everything in it which I was thinking of
regarding style, I just had not read it recently -- my fault!

It is possible that I lost Greek letters through not putting in a
double backslash, though I was trying to put r""" in front of all
docstrings.

I'll look for an example tomorrow as I'm at home now and was doing it
on a machine at work.

>
>> * When I add a nde file into a table of contents and rebuild, the
>> cross-references are not all correct.  Specifically "Previous Topic"
>> is updated but not "Next Topic".  I think.
>>
>> Also, discussion around the review 
>> ofhttp://trac.sagemath.org/sage_trac/ticket/5734led us to the
>> conclusion that we need to have a clear style guide somewhere for
>> reference.  Does this exist?  If so, where?  If not, where should we
>> put it?
>
> Some of this is in the Developer's Guide:
>
Ok, thanks.

John

> <http://sagemath.org/doc/developer/conventions.html#documentation-
> strings>
>
> Is that the sort of thing you are asking about? If you have ideas
> about other things to add, we can open a ticket, or add to #5588.
>
>> John
>
>  John
>
> >
>

--~--~---------~--~----~------------~-------~--~----~
To post to this group, send email to sage-devel@googlegroups.com
To unsubscribe from this group, send 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
-~----------~----~----~----~------~----~------~--~---

Reply via email to