Re: [PATCH 0/9] Prepare Sphinx to build media PDF books
Hi Markus,
Em Wed, 24 Aug 2016 13:46:48 +0200
Markus Heiser escreveu:
> Am 24.08.2016 um 12:42 schrieb Mauro Carvalho Chehab
> :
>
> > Markus,
> >
> > Em Thu, 18 Aug 2016 17:21:27 -0600
> > Jonathan Corbet escreveu:
> >
> >> On Tue, 16 Aug 2016 13:25:34 -0300
> >> Mauro Carvalho Chehab wrote:
> >>
> >>> I think this patch series belong to docs-next. Feel free to merge them
> >>> there, if
> >>> you agree. There's one extra patch that touches Documentation/conf.py,
> >>> re-adding the media book to the PDF build, but IMHO this one would be
> >>> better
> >>> to be merged via the media tree, after the fixes inside the media
> >>> documentation
> >>> to fix the build.
> >>
> >> It's now in docs-next. I was able to build some nice-looking docs with it
> >> without too much (additional) pain...
> >
> > I'm noticing a very weird behavior when I'm building documentation on
> > my server. There, I'm using this command:
> >
> > $ make cleandocs; make V=1 DOCBOOKS="" SPHINXDIRS=media
> > SPHINX_CONF="conf.py" htmldocs
>
> Hi Mauro,
>
> if you build a sub-folder, the conf.py is the default. You don't need
> to name conf.py it explicit and you can leave the DOCBOOKS env.
>
> $ make V=1 SPHINXDIRS=media cleandocs htmldocs
>
> or less verbose:
>
> $ make SPHINXDIRS=media cleandocs htmldocs
Yeah, I know. I added the SPHINX_CONF there because my end goal
is to use the nitpick config, after cleaning it up ;)
>
> But this does not answer your question ;)
>
> > This is what happens on my local machine:
> > http://pastebin.com/VGqvDa7T
>
> Seems to build fine. But this is not "make V=1" log.
>
> > And this is the result of the same command on my server, accessed via ssh:
> > http://pastebin.com/1MFi5LEG
>
> Same here, it is not a "make V=1" log. The errors like:
>
> WARNING: inline latex u"L' = L ^{\\frac{1}{2.19921875}}": latex exited with
> error
>
> are dubious first. Which branch did you compile. It seems you are
> using "inline latex" ... this seems not in Jon's docs-next.
> I checked your experimental docs-next, there is a related
> markup, so I think you compiling this branch.
>
> .. math::
>
>L' = L ^{\frac{1}{2.19921875}}
>
> So I guess the error message is related to one of the sphinx-extensions:
>
> # The name of the math extension changed on Sphinx 1.4
> if minor > 3:
>extensions.append("sphinx.ext.imgmath")
> else:
>extensions.append("sphinx.ext.pngmath")
>
> Since there is a log "Running Sphinx v1.4.6" (both, desktop and server) I
> guess it is related to the sphinx.ext.imgmath extension.
>
> I haven't tested math-extensions yet, I will give it a try
> and send you my experience later. In the meantime you can check
> your math-extensions on desktop and server ...
>
> In general I guess:
>
> 0.) you compiling different branches
>
> or
>
> 1.) on your desktop the math-extension miss some latex stuff
> and does not run, so you get no errors (or it runs perfect
> without any error).
Thanks! that was the case...
I had already those two extensions that are needed by math:
texlive-amsmath-svn30645.2.14-24.fc24.1.noarch
texlive-amsfonts-svn29208.3.04-24.fc24.1.noarch
But it was missing this one on the server:
texlive-anyfontsize.noarch
> > Also, if I use the "-j33" sphinx option, it complains:
> >
> > WARNING: the kernel_include extension does not declare if it is safe for
> > parallel reading, assuming it isn't - please ask the extension author to
> > check and make it explicit
> > WARNING: doing serial read
>
> Yes I know, it is the same with the kernel_doc extension, I can send a patch
> for both.
That will be very much appreciated, thanks!
> > Btw, we need to add support to build just one PDF file, as we did with
> > the htmldocs.
>
> You mean, when you build a subfolder (SPHINXDIRS=media), you wanted
> to build a PDF with only media stuff in .. right?
Yes.
> .. thats what
> I suggested in one of my last mails .. I can sent a patch for this.
Please do that.
Thanks!
Mauro
--
To unsubscribe from this list: send the line "unsubscribe linux-media" in
the body of a message to majord...@vger.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html
Re: [PATCH 0/9] Prepare Sphinx to build media PDF books
Am 24.08.2016 um 12:42 schrieb Mauro Carvalho Chehab :
> Markus,
>
> Em Thu, 18 Aug 2016 17:21:27 -0600
> Jonathan Corbet escreveu:
>
>> On Tue, 16 Aug 2016 13:25:34 -0300
>> Mauro Carvalho Chehab wrote:
>>
>>> I think this patch series belong to docs-next. Feel free to merge them
>>> there, if
>>> you agree. There's one extra patch that touches Documentation/conf.py,
>>> re-adding the media book to the PDF build, but IMHO this one would be better
>>> to be merged via the media tree, after the fixes inside the media
>>> documentation
>>> to fix the build.
>>
>> It's now in docs-next. I was able to build some nice-looking docs with it
>> without too much (additional) pain...
>
> I'm noticing a very weird behavior when I'm building documentation on
> my server. There, I'm using this command:
>
> $ make cleandocs; make V=1 DOCBOOKS="" SPHINXDIRS=media
> SPHINX_CONF="conf.py" htmldocs
Hi Mauro,
if you build a sub-folder, the conf.py is the default. You don't need
to name conf.py it explicit and you can leave the DOCBOOKS env.
$ make V=1 SPHINXDIRS=media cleandocs htmldocs
or less verbose:
$ make SPHINXDIRS=media cleandocs htmldocs
But this does not answer your question ;)
> This is what happens on my local machine:
> http://pastebin.com/VGqvDa7T
Seems to build fine. But this is not "make V=1" log.
> And this is the result of the same command on my server, accessed via ssh:
> http://pastebin.com/1MFi5LEG
Same here, it is not a "make V=1" log. The errors like:
WARNING: inline latex u"L' = L ^{\\frac{1}{2.19921875}}": latex exited with
error
are dubious first. Which branch did you compile. It seems you are
using "inline latex" ... this seems not in Jon's docs-next.
I checked your experimental docs-next, there is a related
markup, so I think you compiling this branch.
.. math::
L' = L ^{\frac{1}{2.19921875}}
So I guess the error message is related to one of the sphinx-extensions:
# The name of the math extension changed on Sphinx 1.4
if minor > 3:
extensions.append("sphinx.ext.imgmath")
else:
extensions.append("sphinx.ext.pngmath")
Since there is a log "Running Sphinx v1.4.6" (both, desktop and server) I
guess it is related to the sphinx.ext.imgmath extension.
I haven't tested math-extensions yet, I will give it a try
and send you my experience later. In the meantime you can check
your math-extensions on desktop and server ...
In general I guess:
0.) you compiling different branches
or
1.) on your desktop the math-extension miss some latex stuff
and does not run, so you get no errors (or it runs perfect
without any error).
or / and
2.) on your server the math-extension runs and has some
problems with the "L' = L ^{\frac{1}{2.19921875}}" expression.
> As you can see, it seems that internally sphinx is calling a
> make -C Documentation/output/latex, with is very bad, because it takes
> a lot of extra time to run and produces an useless output. It also produces
> a wrong output, as it would be calling pdflatex, instead of xelatex.
As said, I haven't tested math-extensions yet. But the math extension
uses "latex" as default / not xelatex
* imgmath_latex:
http://www.sphinx-doc.org/en/stable/ext/math.html#module-sphinx.ext.imgmath
* pngmath_latex:
https://linuxtv.org/downloads/sphinx-1.2.3/ext/math.html#module-sphinx.ext.pngmath
> Do you have any glue about what's going on?
No ;-) ... check the math-extension process as described above.
> Also, if I use the "-j33" sphinx option, it complains:
>
> WARNING: the kernel_include extension does not declare if it is safe for
> parallel reading, assuming it isn't - please ask the extension author to
> check and make it explicit
> WARNING: doing serial read
Yes I know, it is the same with the kernel_doc extension, I can send a patch
for both.
> Btw, we need to add support to build just one PDF file, as we did with
> the htmldocs.
You mean, when you build a subfolder (SPHINXDIRS=media), you wanted
to build a PDF with only media stuff in .. right? .. thats what
I suggested in one of my last mails .. I can sent a patch for this.
-- Markus --
--
To unsubscribe from this list: send the line "unsubscribe linux-media" in
the body of a message to majord...@vger.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html
Re: [PATCH 0/9] Prepare Sphinx to build media PDF books
Markus, Em Thu, 18 Aug 2016 17:21:27 -0600 Jonathan Corbet escreveu: > On Tue, 16 Aug 2016 13:25:34 -0300 > Mauro Carvalho Chehab wrote: > > > I think this patch series belong to docs-next. Feel free to merge them > > there, if > > you agree. There's one extra patch that touches Documentation/conf.py, > > re-adding the media book to the PDF build, but IMHO this one would be better > > to be merged via the media tree, after the fixes inside the media > > documentation > > to fix the build. > > It's now in docs-next. I was able to build some nice-looking docs with it > without too much (additional) pain... I'm noticing a very weird behavior when I'm building documentation on my server. There, I'm using this command: $ make cleandocs; make V=1 DOCBOOKS="" SPHINXDIRS=media SPHINX_CONF="conf.py" htmldocs This is what happens on my local machine: http://pastebin.com/VGqvDa7T And this is the result of the same command on my server, accessed via ssh: http://pastebin.com/1MFi5LEG As you can see, it seems that internally sphinx is calling a make -C Documentation/output/latex, with is very bad, because it takes a lot of extra time to run and produces an useless output. It also produces a wrong output, as it would be calling pdflatex, instead of xelatex. Do you have any glue about what's going on? Also, if I use the "-j33" sphinx option, it complains: WARNING: the kernel_include extension does not declare if it is safe for parallel reading, assuming it isn't - please ask the extension author to check and make it explicit WARNING: doing serial read Btw, we need to add support to build just one PDF file, as we did with the htmldocs. Thanks, Mauro -- To unsubscribe from this list: send the line "unsubscribe linux-media" in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
Re: [PATCH 0/9] Prepare Sphinx to build media PDF books
Em Thu, 18 Aug 2016 17:21:27 -0600 Jonathan Corbet escreveu: > On Tue, 16 Aug 2016 13:25:34 -0300 > Mauro Carvalho Chehab wrote: > > > I think this patch series belong to docs-next. Feel free to merge them > > there, if > > you agree. There's one extra patch that touches Documentation/conf.py, > > re-adding the media book to the PDF build, but IMHO this one would be better > > to be merged via the media tree, after the fixes inside the media > > documentation > > to fix the build. > > It's now in docs-next. I was able to build some nice-looking docs with it > without too much (additional) pain... Good! > The conf.py patch makes me a bit nervous, in that I feel like I spent a > fair amount of time explaining docs merge conflicts to Linus during the > merge window, and would rather not do that again. Can we keep it aside, > with the idea that one of us will put it in toward the end of the 4.9 > merge window? Yeah, sure. I'm actually planning to pull from your docs-next branch at the media master tree before starting picking other patches on it, and wait for your pull request before sending mine on the next merge tree. > Meanwhile, let's see how this xelatex thing works out. Thanks for making > all this work! Anytime! Thanks, Mauro -- To unsubscribe from this list: send the line "unsubscribe linux-media" in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
Re: [PATCH 0/9] Prepare Sphinx to build media PDF books
On Tue, 16 Aug 2016 13:25:34 -0300 Mauro Carvalho Chehab wrote: > I think this patch series belong to docs-next. Feel free to merge them there, > if > you agree. There's one extra patch that touches Documentation/conf.py, > re-adding the media book to the PDF build, but IMHO this one would be better > to be merged via the media tree, after the fixes inside the media > documentation > to fix the build. It's now in docs-next. I was able to build some nice-looking docs with it without too much (additional) pain... The conf.py patch makes me a bit nervous, in that I feel like I spent a fair amount of time explaining docs merge conflicts to Linus during the merge window, and would rather not do that again. Can we keep it aside, with the idea that one of us will put it in toward the end of the 4.9 merge window? Meanwhile, let's see how this xelatex thing works out. Thanks for making all this work! jon -- To unsubscribe from this list: send the line "unsubscribe linux-media" in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
[PATCH 0/9] Prepare Sphinx to build media PDF books
This patch series fix Sphinx to allow it to build the media documentation as a PDF file. The first patch is actually a bug fix: one of the previous patch broke compilation for PDF as a hole, as it added an extra parenthesis to a function call. The second patch just removes a left over code for rst2pdf. The other patches change from "pdflatex" to "xelatex" and address several issues that prevent building the media books. Jon, I think this patch series belong to docs-next. Feel free to merge them there, if you agree. There's one extra patch that touches Documentation/conf.py, re-adding the media book to the PDF build, but IMHO this one would be better to be merged via the media tree, after the fixes inside the media documentation to fix the build. I'm sending the media-specific patches on a separate patch series, meant to be merged via the media tree. As on the previous experimental patch series, I'm pushing the entire stuff on my development tree, at: https://git.linuxtv.org//mchehab/experimental.git/log/?h=docs-next The generated PDF file is at: https://mchehab.fedorapeople.org/media.pdf Please notice that lots of tables are broken. Fixing them would require manual work, as we'll need to add tags to specify the column size via tabularcolumns, long tables should use the cssclass:: longtable, and very wide tables will need to be rotated and size-adjusted. Anyway, at least *some* PDF support for media books are now possible. Mauro Carvalho Chehab (9): docs-rst: fix a breakage when building PDF documents docs-rst: remove a rst2pdf left over code docs-rst: allow generating some LaTeX pages in landscape docs-rst: improve output for .. notes:: on LaTeX docs-rst: Don't mangle with UTF-8 chars on LaTeX/PDF output docs-rst: better adjust margins and font size docs-rst: parse-heraders.pl: escape LaTeX characters docs-rst: Don't go to interactive mode on errors docs-rst: enable the Sphinx math extension Documentation/Makefile.sphinx | 8 ++--- Documentation/conf.py | 66 +-- Documentation/sphinx/parse-headers.pl | 2 +- 3 files changed, 60 insertions(+), 16 deletions(-) -- 2.7.4 -- To unsubscribe from this list: send the line "unsubscribe linux-media" in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
