[Doc-SIG] sphinx bug

Ondrej Certik ondrej at certik.cz
Sun Mar 23 21:07:02 CET 2008


>  > Anyway, the project is great. We moved the docs in ipython to it and
>  > we are going to move sympy docs as well.
>
>  That's great news! If you need anything, let me know.

Now I am figuring out how to use templates so that the search box is
available on all pages.

>  > We found a bug though. If python-pygments isn't installed, sphinx
>  > doesn't say anything, "make latex" hapilly generate a latex file, but
>  > this latex file fails to compile:
>  >
>  > ! Undefined control sequence.
>  > <argument> In \lb
>  >                   []1\rb []: from ipython1.kernel import client
>  > l.1205 ...rb[]: from ipython1.kernel import client
>  >
>  > That's because the latex file is missing some definitions, like \lb,
>  > that only get included when python-pygments is installed.
>  >
>  > Do you think the file sphinx/highlighting.py line 30 could be fixed to
>  > emit a large warning message, that the latex output will be broken
>  > (possibly with an explanation of the problem)? That way one can easily
>  > spot it and fix it.
>
>  It's even easier to fix the markup so that it will work regardless of
>  Pygments installed or not.

You mean in rst? I think we are using just regular ::

  some code

>
>
>  > Actually it took my 45 minutes of debugging with winpdb to figure out
>  > what's wrong, because I had one computer where it worked and another
>  > where it didn't. I compared all Debian latex packages on both, but it
>  > didn't occur to me the problem could by in missing pygments. But I am
>  > glad I figured this out. :)
>
>  Thanks for the report! It's fixed in SVN trunk now (r61806).

Thanks for the fix!

Ondrej


More information about the Doc-SIG mailing list