Vladimir, I can take a look at that and try to get that docstring to properly leverage Sphinx. I think it would be fine to drop the * and make it show up as something monospace so it's clear it corresponds to the parameter.
Sean On Thu, Feb 2, 2012 at 13:38, Vladimir Perić <vlada.pe...@gmail.com> wrote: > Right, me again, second issue: > > In the docstring of JzKetCoupled there's a bunch of "*jn" "*jcoupling" > etc. Now these produce errors for Sphinx (because a star is used to > denote the start of emphasized text). As far as I gather, the usual > way to fix these is to define the docstring as a raw string (with > r"""...) and then escape the stars with a backslash, but I feel that > will hurt readibility too much in this case. Thoughts? > > On Thu, Feb 2, 2012 at 8:18 PM, Vladimir Perić <vlada.pe...@gmail.com> > wrote: > > Hello, > > > > There have been a lot of efforts, both during GCI and before it, to > > fix all the warnings generated by sphinx with "make html". Now, of > > course, this is a moving target so any time we manage to get closer we > > push in some other changes which add a bunch of new warnings and we > > are right where we started. I'd like to take care of this once and for > > all. To this effect, I've merged pull request 918[1] (which is the > > latest GCI-related pull; I had a feeling the student wouldn't > > follow-through) on current master. The results can be seeon my branch > > sphinx-docs [2]. Now, the biggest problem is caused by the (recently > > added) core/relational.py file. These errors are particularly painful > > because Sphinx seems to print out whole dictionaries of.. something.. > > in order to report the error, which makes it hard to work with. Will > > someone who is more familiar with rST and Sphinx in general be able to > > help? You can submit a pull request against my branch, or just send a > > separate pull to the main repo (but I'd prefer the first). Thanks in > > advance! (I know the "resident specialist" is @miham on Github, but I > > don't know his direct mail) > > > > Other than that, I think most of the errors I'll be able to figure out > > myself. If there are any other major issues, I'll write here. > > > > > > [1] https://github.com/sympy/sympy/pull/918 > > [2] https://github.com/vperic/sympy/tree/sphinx-docs > > -- > > Vladimir Perić > > > > -- > Vladimir Perić > > -- > You received this message because you are subscribed to the Google Groups > "sympy" group. > To post to this group, send email to sympy@googlegroups.com. > To unsubscribe from this group, send email to > sympy+unsubscr...@googlegroups.com. > For more options, visit this group at > http://groups.google.com/group/sympy?hl=en. > > -- You received this message because you are subscribed to the Google Groups "sympy" group. To post to this group, send email to sympy@googlegroups.com. To unsubscribe from this group, send email to sympy+unsubscr...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/sympy?hl=en.
