I don't usually read the pdf docs either, but it is the only test that the
math in doctstrings actually validates. Sphnix doesn't know if the
`\frac{1}{2}` in the doctstring is admissible math, and if not it'll only
fail in the browser when the end-user tries to read the docs...
On Thursday, June 12, 2014 1:43:27 PM UTC+1, Nathann Cohen wrote:
>
> Hello guys !
>
> I wanted to ask you if you had ever found the pdf version of the manual
> useful for anything, or if we could just give it up.
>
> The problem we have is that the category/ folder contains things like
>
> class A:
> class B:
> class C:
> class D:
> def Hey():
> pass
>
> and that function "Hey" does not appear in the doc as a result. A ticket
> [1] was opened for this 4 years ago but it got stuck because documenting
> these functions leads Sphinx to generate a LaTeX document that does not
> compile, because "the nesting is too important".
>
> This should of course remind us that we cannot trust LaTeX with anything,
> but more importantly we *DO* need those functions to appear in the
> documentation.
>
> So well. Given that the ticket is already 4 years old, if everybody agrees
> that the pdf documentation is totally useless, we could just throw it away
> and have all our functions appear in the doc at zero cost.
>
> Have fun !
>
> Nathann
>
> P.S. : If you never opened the PDF version of the manual you can see for
> yourself how useless it is to find any info by going there :
> http://www.sagemath.org/pdf/en/reference/
> (yes, many doctests cross the margins)
>
> [1] http://trac.sagemath.org/ticket/9107
>
--
You received this message because you are subscribed to the Google Groups
"sage-devel" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to sage-devel+unsubscr...@googlegroups.com.
To post to this group, send email to sage-devel@googlegroups.com.
Visit this group at http://groups.google.com/group/sage-devel.
For more options, visit https://groups.google.com/d/optout.
