Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]


Groups > linux.kernel > #1515963 > unrolled thread

Including images on Sphinx documents

Started byMauro Carvalho Chehab <mchehab@s-opensource.com>
First post2016-11-07 11:00 +0100
Last post2016-11-14 14:40 +0100
Articles 11 on this page of 51 — 18 participants

Back to article view | Back to linux.kernel


Contents

  Including images on Sphinx documents Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-11-07 11:00 +0100
    Re: Including images on Sphinx documents Jani Nikula <jani.nikula@intel.com> - 2016-11-07 12:00 +0100
      Re: Including images on Sphinx documents Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-11-07 12:50 +0100
        Re: [Ksummit-discuss] Including images on Sphinx documents Josh Triplett <josh@joshtriplett.org> - 2016-11-07 18:10 +0100
          Re: [Ksummit-discuss] Including images on Sphinx documents Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-11-08 12:00 +0100
            Re: [Ksummit-discuss] Including images on Sphinx documents Arnd Bergmann <arnd@arndb.de> - 2016-11-16 17:10 +0100
              Re: [Ksummit-discuss] Including images on Sphinx documents Mauro Carvalho Chehab <mchehab@infradead.org> - 2016-11-16 21:30 +0100
                Re: [Ksummit-discuss] Including images on Sphinx documents Arnd Bergmann <arnd@arndb.de> - 2016-11-17 12:10 +0100
                  Re: [Ksummit-discuss] Including images on Sphinx documents Jani Nikula <jani.nikula@intel.com> - 2016-11-17 12:30 +0100
                    Re: [Ksummit-discuss] Including images on Sphinx documents Mauro Carvalho Chehab <mchehab@infradead.org> - 2016-11-17 18:10 +0100
                  Re: [Ksummit-discuss] Including images on Sphinx documents Mauro Carvalho Chehab <mchehab@infradead.org> - 2016-11-17 18:10 +0100
                  Re: [Ksummit-discuss] Including images on Sphinx documents Linus Torvalds <torvalds@linux-foundation.org> - 2016-11-17 18:10 +0100
                  Re: [Ksummit-discuss] Including images on Sphinx documents James Bottomley <James.Bottomley@HansenPartnership.com> - 2016-11-17 18:10 +0100
                  Re: [Ksummit-discuss] Including images on Sphinx documents Mauro Carvalho Chehab <mchehab@infradead.org> - 2016-11-17 18:20 +0100
                    Re: [Ksummit-discuss] Including images on Sphinx documents Johannes Berg <johannes@sipsolutions.net> - 2016-11-17 18:30 +0100
                  Re: [Ksummit-discuss] Including images on Sphinx documents Theodore Ts'o <tytso@mit.edu> - 2016-11-17 18:30 +0100
                  Re: [Ksummit-discuss] Including images on Sphinx documents Linus Torvalds <torvalds@linux-foundation.org> - 2016-11-17 19:10 +0100
                    Re: [Ksummit-discuss] Including images on Sphinx documents Jani Nikula <jani.nikula@intel.com> - 2016-11-18 10:20 +0100
                      Re: [Ksummit-discuss] Including images on Sphinx documents Daniel Vetter <daniel@ffwll.ch> - 2016-11-18 11:30 +0100
                    Re: [Ksummit-discuss] Including images on Sphinx documents Jonathan Corbet <corbet@lwn.net> - 2016-11-19 18:20 +0100
                      Re: [Ksummit-discuss] Including images on Sphinx documents Andrew Lunn <andrew@lunn.ch> - 2016-11-19 18:40 +0100
                      Re: [Ksummit-discuss] Including images on Sphinx documents Bart Van Assche <Bart.VanAssche@sandisk.com> - 2016-11-19 19:00 +0100
                      Re: [Ksummit-discuss] Including images on Sphinx documents David Woodhouse <dwmw2@infradead.org> - 2016-11-19 19:00 +0100
                        Re: [Ksummit-discuss] Including images on Sphinx documents Linus Torvalds <torvalds@linux-foundation.org> - 2016-11-19 19:50 +0100
                          Re: [Ksummit-discuss] Including images on Sphinx documents "David Woodhouse" <dwmw2@infradead.org> - 2016-11-20 00:30 +0100
                            Re: [Ksummit-discuss] Including images on Sphinx documents Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-11-20 15:30 +0100
                      Re: [Ksummit-discuss] Including images on Sphinx documents Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-11-19 22:00 +0100
                        Re: [Ksummit-discuss] Including images on Sphinx documents Linus Torvalds <torvalds@linux-foundation.org> - 2016-11-19 22:10 +0100
                      Re: [Ksummit-discuss] Including images on Sphinx documents Johannes Berg <johannes@sipsolutions.net> - 2016-11-21 11:40 +0100
                        Re: [Ksummit-discuss] Including images on Sphinx documents Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-11-21 15:10 +0100
                          Re: [Ksummit-discuss] Including images on Sphinx documents Jani Nikula <jani.nikula@linux.intel.com> - 2016-11-21 16:50 +0100
                          Re: [Ksummit-discuss] Including images on Sphinx documents Johannes Berg <johannes@sipsolutions.net> - 2016-11-21 16:50 +0100
                            Re: [Ksummit-discuss] Including images on Sphinx documents Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-11-21 20:50 +0100
                          Re: [Ksummit-discuss] Including images on Sphinx documents James Bottomley <James.Bottomley@HansenPartnership.com> - 2016-11-21 16:50 +0100
        Re: Including images on Sphinx documents Jonathan Corbet <corbet@lwn.net> - 2016-11-13 22:10 +0100
          Re: Including images on Sphinx documents Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-11-14 15:20 +0100
      Re: Including images on Sphinx documents Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-11-09 13:30 +0100
    Re: [Ksummit-discuss] Including images on Sphinx documents Josh Triplett <josh@joshtriplett.org> - 2016-11-07 18:30 +0100
      Re: [Ksummit-discuss] Including images on Sphinx documents Markus Heiser <markus.heiser@darmarit.de> - 2016-11-09 10:30 +0100
        Re: [Ksummit-discuss] Including images on Sphinx documents Jani Nikula <jani.nikula@linux.intel.com> - 2016-11-09 12:20 +0100
          Re: [Ksummit-discuss] Including images on Sphinx documents Markus Heiser <markus.heiser@darmarit.de> - 2016-11-09 12:30 +0100
            Re: [Ksummit-discuss] Including images on Sphinx documents Jani Nikula <jani.nikula@linux.intel.com> - 2016-11-09 13:00 +0100
              Re: [Ksummit-discuss] Including images on Sphinx documents Markus Heiser <markus.heiser@darmarit.de> - 2016-11-09 23:20 +0100
                Re: [Ksummit-discuss] Including images on Sphinx documents Jani Nikula <jani.nikula@linux.intel.com> - 2016-11-10 11:40 +0100
                  Re: [Ksummit-discuss] Including images on Sphinx documents Jani Nikula <jani.nikula@linux.intel.com> - 2016-11-11 12:30 +0100
                    Re: [Ksummit-discuss] Including images on Sphinx documents Markus Heiser <markus.heiser@darmarit.de> - 2016-11-11 12:50 +0100
              Re: [Ksummit-discuss] Including images on Sphinx documents Mauro Carvalho Chehab <m.chehab@samsung.com> - 2016-11-11 10:40 +0100
          Re: [Ksummit-discuss] Including images on Sphinx documents Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-11-09 12:30 +0100
            Re: [Ksummit-discuss] Including images on Sphinx documents Jani Nikula <jani.nikula@linux.intel.com> - 2016-11-09 12:50 +0100
    Re: Including images on Sphinx documents Jonathan Corbet <corbet@lwn.net> - 2016-11-13 21:00 +0100
      Re: Including images on Sphinx documents Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-11-14 14:40 +0100

Page 3 of 3 — ← Prev page 1 2 [3]


#1518017 — Re: [Ksummit-discuss] Including images on Sphinx documents

FromMarkus Heiser <markus.heiser@darmarit.de>
Date2016-11-09 12:30 +0100
SubjectRe: [Ksummit-discuss] Including images on Sphinx documents
Message-ID<sBzeN-6D4-7@gated-at.bofh.it>
In reply to#1518006
Am 09.11.2016 um 12:16 schrieb Jani Nikula <jani.nikula@linux.intel.com>:
>> So I vote for :
>> 
>>> 1) copy (or symlink) all rst files to Documentation/output (or to the
>>> build dir specified via O= directive) and generate the *.pdf there,
>>> and produce those converted images via Makefile.;
> 
> We're supposed to solve problems, not create new ones.

... new ones? ...

>> IMO placing 'sourcedir' to O= is more sane since this marries the
>> Linux Makefile concept (relative to $PWD) with the sphinx concept
>> (in or below 'sourcedir').

-- Markus --

[toc] | [prev] | [next] | [standalone]


#1518101 — Re: [Ksummit-discuss] Including images on Sphinx documents

FromJani Nikula <jani.nikula@linux.intel.com>
Date2016-11-09 13:00 +0100
SubjectRe: [Ksummit-discuss] Including images on Sphinx documents
Message-ID<sBzHP-6Ng-1@gated-at.bofh.it>
In reply to#1518017
On Wed, 09 Nov 2016, Markus Heiser <markus.heiser@darmarit.de> wrote:
> Am 09.11.2016 um 12:16 schrieb Jani Nikula <jani.nikula@linux.intel.com>:
>>> So I vote for :
>>> 
>>>> 1) copy (or symlink) all rst files to Documentation/output (or to the
>>>> build dir specified via O= directive) and generate the *.pdf there,
>>>> and produce those converted images via Makefile.;
>> 
>> We're supposed to solve problems, not create new ones.
>
> ... new ones? ...

Handle in-tree builds without copying.

Make dependency analysis with source rst and "intermediate" rst work.

Make sure your copying gets the timestamps right.

Make Sphinx dependency analysis look at the right copies depending on
in-tree vs. out-of-tree. Generally make sure it doesn't confuse Sphinx's
own dependency analysis.

The stuff I didn't think of.

Sure, it's all supposed to be basic Makefile stuff, but don't make the
mistake of thinking just one invocation of 'cp' will solve all the
problems. It all adds to the complexity we were trying to avoid when
dumping DocBook. It adds to the complexity of debugging stuff. (And hey,
there's still the one rebuilding-stuff-for-no-reason issue open.)

If you want to keep the documentation build sane, try to avoid the
Makefile preprocessing. And same old story, if you fix this for real,
even if as a Sphinx extension, *other* people than kernel developers
will be interested, and *we* don't have to do so much ourselves.


BR,
Jani.



>
>>> IMO placing 'sourcedir' to O= is more sane since this marries the
>>> Linux Makefile concept (relative to $PWD) with the sphinx concept
>>> (in or below 'sourcedir').
>
> -- Markus --

-- 
Jani Nikula, Intel Open Source Technology Center

[toc] | [prev] | [next] | [standalone]


#1518520 — Re: [Ksummit-discuss] Including images on Sphinx documents

FromMarkus Heiser <markus.heiser@darmarit.de>
Date2016-11-09 23:20 +0100
SubjectRe: [Ksummit-discuss] Including images on Sphinx documents
Message-ID<sBJnQ-50l-3@gated-at.bofh.it>
In reply to#1518101
On 09.11.2016 12:58, Jani Nikula wrote:
 > On Wed, 09 Nov 2016, Markus Heiser <markus.heiser@darmarit.de> wrote:
 >> Am 09.11.2016 um 12:16 schrieb Jani Nikula <jani.nikula@linux.intel.com>:
 >>>> So I vote for :
 >>>>
 >>>>> 1) copy (or symlink) all rst files to Documentation/output (or to the
 >>>>> build dir specified via O= directive) and generate the *.pdf there,
 >>>>> and produce those converted images via Makefile.;
 >>>
 >>> We're supposed to solve problems, not create new ones.
 >>
 >> ... new ones? ...
 >
 > Handle in-tree builds without copying.
 >
 > Make dependency analysis with source rst and "intermediate" rst work.
 >
 > Make sure your copying gets the timestamps right.
 >
 > Make Sphinx dependency analysis look at the right copies depending on
 > in-tree vs. out-of-tree. Generally make sure it doesn't confuse Sphinx's
 > own dependency analysis.
 >
 > The stuff I didn't think of.

It might be easier than you think first.

 > Sure, it's all supposed to be basic Makefile stuff, but don't make the mistake
 > of thinking just one invocation of 'cp' will solve all the problems.

I act naif using 'cp -sa', see patch below.

 > It all adds to the complexity we were trying to avoid when dumping DocBook. It
 > adds to the complexity of debugging stuff. (And hey, there's still the one
 > rebuilding-stuff-for-no-reason issue open.)

And hey ;-) I wrote you [1], this is a bug in Sphinx. Yes, I haven't had time
to send a bugfix to Sphinx, but this won't even help us (bugfixes in Sphinx will
only apply on top).

 > If you want to keep the documentation build sane, try to avoid the Makefile
 > preprocessing.

I'am just the one helping Mauro to be productive, if he needs preprocessing I
implement proposals. I know that you fear preprocessing since it tend to
fall-back, what we had with DocBook's build process.  We discussed this already,
it might better you unify this with Mauro and the other who need preprocessing.

 > And same old story, if you fix this for real, even if as a Sphinx extension,
 > *other* people than kernel developers will be interested, and *we* don't have
 > to do so much ourselves.

I don't think so, this kind of parsing header files we have and the build of
content from MAINTAINERS, ABI, etc. is very kernel specific.

Anyway, back to my point 'copy (or symlink) all rst files'. Please take a look
at my patch below. Take in mind; its just a POC.

Could this POC persuade you, if so, I send a more elaborate RFC,
what do you think about?

[1] https://www.mail-archive.com/linux-doc@vger.kernel.org/msg07302.html

-- Markus --

 > BR,
 > Jani.
 >>
 >>>> IMO placing 'sourcedir' to O= is more sane since this marries the
 >>>> Linux Makefile concept (relative to $PWD) with the sphinx concept
 >>>> (in or below 'sourcedir').
 >>
 >> -- Markus --
 >

diff --git a/Documentation/Makefile.sphinx b/Documentation/Makefile.sphinx
index ec0c77d..8e904c1 100644
--- a/Documentation/Makefile.sphinx
+++ b/Documentation/Makefile.sphinx
@@ -13,6 +13,10 @@ BUILDDIR      = $(obj)/output
  PDFLATEX      = xelatex
  LATEXOPTS     = -interaction=batchmode

+ifdef SPHINXDIRS
+else
+endif
+
  # User-friendly check for sphinx-build
  HAVE_SPHINX := $(shell if which $(SPHINXBUILD) >/dev/null 2>&1; then echo 1; else echo 0; fi)

@@ -50,30 +54,38 @@ loop_cmd = $(echo-cmd) $(cmd_$(1))
  #    * dest folder relative to $(BUILDDIR) and
  #    * cache folder relative to $(BUILDDIR)/.doctrees
  # $4 dest subfolder e.g. "man" for man pages at media/man
-# $5 reST source folder relative to $(srctree)/$(src),
+# $5 reST source folder relative to $(obj),
  #    e.g. "media" for the linux-tv book-set at ./Documentation/media

  quiet_cmd_sphinx = SPHINX  $@ --> file://$(abspath $(BUILDDIR)/$3/$4)
-      cmd_sphinx = $(MAKE) BUILDDIR=$(abspath $(BUILDDIR)) $(build)=Documentation/media all;\
-	BUILDDIR=$(abspath $(BUILDDIR)) SPHINX_CONF=$(abspath $(srctree)/$(src)/$5/$(SPHINX_CONF)) \
+      cmd_sphinx = $(MAKE) BUILDDIR=$(BUILDDIR) $(build)=Documentation/media all;\
+	BUILDDIR=$(BUILDDIR) SPHINX_CONF=$(obj)/$5/$(SPHINX_CONF) \
  	$(SPHINXBUILD) \
  	-b $2 \
-	-c $(abspath $(srctree)/$(src)) \
-	-d $(abspath $(BUILDDIR)/.doctrees/$3) \
+	-c $(obj) \
+	-d $(obj)/.doctrees/$3 \
  	-D version=$(KERNELVERSION) -D release=$(KERNELRELEASE) \
  	$(ALLSPHINXOPTS) \
-	$(abspath $(srctree)/$(src)/$5) \
-	$(abspath $(BUILDDIR)/$3/$4);
-
-htmldocs:
+	$(obj)/$5 \
+	$(BUILDDIR)/$3/$4;
+
+ifdef O
+sync:
+	rm -rf $(objtree)/$(obj)
+	cp -sa $(srctree)/$(obj) $(objtree)
+else
+sync:
+endif
+
+htmldocs: sync
  	@$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,html,$(var),,$(var)))

-latexdocs:
+latexdocs: sync
  	@$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,latex,$(var),latex,$(var)))

  ifeq ($(HAVE_PDFLATEX),0)

-pdfdocs:
+pdfdocs: sync
  	$(warning The '$(PDFLATEX)' command was not found. Make sure you have it installed and in PATH to produce PDF output.)
  	@echo "  SKIP    Sphinx $@ target."

@@ -84,10 +96,10 @@ pdfdocs: latexdocs

  endif # HAVE_PDFLATEX

-epubdocs:
+epubdocs: sync
  	@$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,epub,$(var),epub,$(var)))

-xmldocs:
+xmldocs: sync
  	@$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,xml,$(var),xml,$(var)))

  # no-ops for the Sphinx toolchain
@@ -98,6 +110,7 @@ installmandocs:

  cleandocs:
  	$(Q)rm -rf $(BUILDDIR)
+	$(Q)rm -rf $(obj)/.doctrees

  endif # HAVE_SPHINX

[toc] | [prev] | [next] | [standalone]


#1518841 — Re: [Ksummit-discuss] Including images on Sphinx documents

FromJani Nikula <jani.nikula@linux.intel.com>
Date2016-11-10 11:40 +0100
SubjectRe: [Ksummit-discuss] Including images on Sphinx documents
Message-ID<sBUVX-4sp-17@gated-at.bofh.it>
In reply to#1518520
On Thu, 10 Nov 2016, Markus Heiser <markus.heiser@darmarit.de> wrote:
> Could this POC persuade you, if so, I send a more elaborate RFC,
> what do you think about?

Sorry, I do not wish to be part of this.

BR,
Jani.

-- 
Jani Nikula, Intel Open Source Technology Center

[toc] | [prev] | [next] | [standalone]


#1519706 — Re: [Ksummit-discuss] Including images on Sphinx documents

FromJani Nikula <jani.nikula@linux.intel.com>
Date2016-11-11 12:30 +0100
SubjectRe: [Ksummit-discuss] Including images on Sphinx documents
Message-ID<sCibT-3Ek-9@gated-at.bofh.it>
In reply to#1518841
On Thu, 10 Nov 2016, Jani Nikula <jani.nikula@linux.intel.com> wrote:
> On Thu, 10 Nov 2016, Markus Heiser <markus.heiser@darmarit.de> wrote:
>> Could this POC persuade you, if so, I send a more elaborate RFC,
>> what do you think about?
>
> Sorry, I do not wish to be part of this.

That was uncalled for, apologies.

Like I said, I don't think this is the right approach. Call it an
unsubstantiated gut feel coming from experience. However, I do not have
the time to properly dig into this either, and that frustrates me. I
wish I could be more helpful, but I can't right now.

BR,
Jani.


-- 
Jani Nikula, Intel Open Source Technology Center

[toc] | [prev] | [next] | [standalone]


#1519722 — Re: [Ksummit-discuss] Including images on Sphinx documents

FromMarkus Heiser <markus.heiser@darmarit.de>
Date2016-11-11 12:50 +0100
SubjectRe: [Ksummit-discuss] Including images on Sphinx documents
Message-ID<sCivg-3KY-25@gated-at.bofh.it>
In reply to#1519706
Am 11.11.2016 um 12:22 schrieb Jani Nikula <jani.nikula@linux.intel.com>:

> On Thu, 10 Nov 2016, Jani Nikula <jani.nikula@linux.intel.com> wrote:
>> On Thu, 10 Nov 2016, Markus Heiser <markus.heiser@darmarit.de> wrote:
>>> Could this POC persuade you, if so, I send a more elaborate RFC,
>>> what do you think about?
>> 
>> Sorry, I do not wish to be part of this.
> 
> That was uncalled for, apologies.

It's OK, sometimes we are all in a hurry and want shorten things.

> Like I said, I don't think this is the right approach. Call it an
> unsubstantiated gut feel coming from experience.

Yes, building a bunch of symbolic links "smells". Unfortunately,
I currently see no other solution to solve the conflict of 
Linux's "O=/foo" and Sphinx's "sourcedir", so that was my
proposal.

> However, I do not have
> the time to properly dig into this either, and that frustrates me. I
> wish I could be more helpful, but I can't right now.

its a pity

-- Markus --

[toc] | [prev] | [next] | [standalone]


#1519641 — Re: [Ksummit-discuss] Including images on Sphinx documents

FromMauro Carvalho Chehab <m.chehab@samsung.com>
Date2016-11-11 10:40 +0100
SubjectRe: [Ksummit-discuss] Including images on Sphinx documents
Message-ID<sCgtr-2uj-9@gated-at.bofh.it>
In reply to#1518101
Em Wed, 09 Nov 2016 13:58:12 +0200
Jani Nikula <jani.nikula@linux.intel.com> escreveu:

> On Wed, 09 Nov 2016, Markus Heiser <markus.heiser@darmarit.de> wrote:
> > Am 09.11.2016 um 12:16 schrieb Jani Nikula <jani.nikula@linux.intel.com>:  
> >>> So I vote for :
> >>>   
> >>>> 1) copy (or symlink) all rst files to Documentation/output (or to the
> >>>> build dir specified via O= directive) and generate the *.pdf there,
> >>>> and produce those converted images via Makefile.;  
> >> 
> >> We're supposed to solve problems, not create new ones.  
> >
> > ... new ones? ...  
> 
> Handle in-tree builds without copying.
> 
> Make dependency analysis with source rst and "intermediate" rst work.
> 
> Make sure your copying gets the timestamps right.
> 
> Make Sphinx dependency analysis look at the right copies depending on
> in-tree vs. out-of-tree. Generally make sure it doesn't confuse Sphinx's
> own dependency analysis.

I agree with Jani here: copy the files will make Sphinx recompile
the entire documentation every time, with is bad. Ok, Some Makefile
logic could be added to copy only on changes, but that will increase
the Makefile complexity.

So, I prefer not using copy. As I said before, a Sphinx extension that
would make transparent for PDF document generation when a non-PDF image
is included, doing whatever conversion needed, seems to be the right fix 
here, but someone would need to step up and write such extension.

-- 

Cheers,
Mauro

[toc] | [prev] | [next] | [standalone]


#1518024 — Re: [Ksummit-discuss] Including images on Sphinx documents

FromMauro Carvalho Chehab <mchehab@s-opensource.com>
Date2016-11-09 12:30 +0100
SubjectRe: [Ksummit-discuss] Including images on Sphinx documents
Message-ID<sBzeO-6D4-21@gated-at.bofh.it>
In reply to#1518006
Em Wed, 09 Nov 2016 13:16:55 +0200
Jani Nikula <jani.nikula@linux.intel.com> escreveu:

> >> 1) copy (or symlink) all rst files to Documentation/output (or to the
> >>  build dir specified via O= directive) and generate the *.pdf there,
> >>  and produce those converted images via Makefile.;  
> 
> We're supposed to solve problems, not create new ones.

So, what's your proposal?

Thanks,
Mauro

[toc] | [prev] | [next] | [standalone]


#1518091 — Re: [Ksummit-discuss] Including images on Sphinx documents

FromJani Nikula <jani.nikula@linux.intel.com>
Date2016-11-09 12:50 +0100
SubjectRe: [Ksummit-discuss] Including images on Sphinx documents
Message-ID<sBzya-6Ka-25@gated-at.bofh.it>
In reply to#1518024
On Wed, 09 Nov 2016, Mauro Carvalho Chehab <mchehab@s-opensource.com> wrote:
> Em Wed, 09 Nov 2016 13:16:55 +0200
> Jani Nikula <jani.nikula@linux.intel.com> escreveu:
>
>> >> 1) copy (or symlink) all rst files to Documentation/output (or to the
>> >>  build dir specified via O= directive) and generate the *.pdf there,
>> >>  and produce those converted images via Makefile.;  
>> 
>> We're supposed to solve problems, not create new ones.
>
> So, what's your proposal?

Second message in the thread,
http://lkml.kernel.org/r/87wpgf8ssc.fsf@intel.com

>
> Thanks,
> Mauro
> _______________________________________________
> Ksummit-discuss mailing list
> Ksummit-discuss@lists.linuxfoundation.org
> https://lists.linuxfoundation.org/mailman/listinfo/ksummit-discuss

-- 
Jani Nikula, Intel Open Source Technology Center

[toc] | [prev] | [next] | [standalone]


#1520654

FromJonathan Corbet <corbet@lwn.net>
Date2016-11-13 21:00 +0100
Message-ID<sD96x-4KN-15@gated-at.bofh.it>
In reply to#1515963
On Mon, 7 Nov 2016 07:55:24 -0200
Mauro Carvalho Chehab <mchehab@s-opensource.com> wrote:

> So, we have a few alternatives:
> 
> 1) copy (or symlink) all rst files to Documentation/output (or to the
>    build dir specified via O= directive) and generate the *.pdf there,
>    and produce those converted images via Makefile.;
> 
> 2) add an Sphinx extension that would internally call ImageMagick and/or
>    inkscape to convert the bitmap;
> 
> 3) if possible, add an extension to trick Sphinx for it to consider the 
>    output dir as a source dir too.

So, obviously, I've been letting this go by while dealing with other
stuff...

I really think that 2) is the one we want.  Copying all the stuff and
operating on the copies, beyond being a bit of a hack, just seems like a
recipe for weird build problems in the future.

We should figure out why PNG files don't work.  Maybe I'll give that a
try at some point soon, if I can find a moment.  Working around tools
bugs seems like the wrong approach.

Working from .svg seems optimial, but I don't like the --shell-escape
thing at all.

[Along those lines, we've picked up a lot of lines like this:

	 restricted \write18 enabled.

That, too, is shell execution stuff.  I've not been able to figure out
where it came from, but I would sure like to get rid of it...]

jon

[toc] | [prev] | [next] | [standalone]


#1521648

FromMauro Carvalho Chehab <mchehab@s-opensource.com>
Date2016-11-14 14:40 +0100
Message-ID<sDpEm-7Av-31@gated-at.bofh.it>
In reply to#1520654
Em Sun, 13 Nov 2016 12:52:50 -0700
Jonathan Corbet <corbet@lwn.net> escreveu:

> On Mon, 7 Nov 2016 07:55:24 -0200
> Mauro Carvalho Chehab <mchehab@s-opensource.com> wrote:
> 
> > So, we have a few alternatives:
> > 
> > 1) copy (or symlink) all rst files to Documentation/output (or to the
> >    build dir specified via O= directive) and generate the *.pdf there,
> >    and produce those converted images via Makefile.;
> > 
> > 2) add an Sphinx extension that would internally call ImageMagick and/or
> >    inkscape to convert the bitmap;
> > 
> > 3) if possible, add an extension to trick Sphinx for it to consider the 
> >    output dir as a source dir too.  
> 
> So, obviously, I've been letting this go by while dealing with other
> stuff...
> 
> I really think that 2) is the one we want.  Copying all the stuff and
> operating on the copies, beyond being a bit of a hack, just seems like a
> recipe for weird build problems in the future.

Yes, (2) sounds to be the best option.

> We should figure out why PNG files don't work.  Maybe I'll give that a
> try at some point soon, if I can find a moment.  Working around tools
> bugs seems like the wrong approach.

I appreciate any efforts on that.

> Working from .svg seems optimial, but I don't like the --shell-escape
> thing at all.
> 
> [Along those lines, we've picked up a lot of lines like this:
> 
> 	 restricted \write18 enabled.
> 
> That, too, is shell execution stuff.  I've not been able to figure out
> where it came from, but I would sure like to get rid of it...]

Didn't know that! I'm new to LaTeX. Frankly, the log output sounds
very scary to me, as there are lots of warnings there, and debugging
each of them takes time. I don't see any \write18 inside the generated
.tex files or inside the sphinx.sty file. Perhaps it comes from some
Tex extension, like adjustbox?

> 
> jon



Thanks,
Mauro

[toc] | [prev] | [standalone]


Page 3 of 3 — ← Prev page 1 2 [3]

Back to top | Article view | linux.kernel


csiph-web