Re: [PATCH 0/3] doc-rst: generic way to build PDF of sub-folder

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Am 26.08.2016 um 13:34 schrieb Mauro Carvalho Chehab <mchehab@xxxxxxxxxxxxx>:

> Hi Markus,
> 
> Em Wed, 24 Aug 2016 17:36:13 +0200
> Markus Heiser <markus.heiser@xxxxxxxxxxx> escreveu:
> 
>> From: Markus Heiser <markus.heiser@xxxxxxxxxxx>
>> 
>> Hi Mauro,
>> 
>> here is a small patch series which extends the method to build only sub-folders
>> to the targets "latexdocs" and "pdfdocs".
>> 
>> If you think, that the two first patches works for you, path them with your next
>> merge to Jon's doc-next.
>> 
>> The last patch in this series is just for you. It is a small example to
>> illustrate how we can build small books and link them with intersphinx.
> 
> Didn't actually review the patches (I'm about to take a short trip).
> Just tested the results of those 3 patches. 
> 
> It worked. However, I saw two issues there:
> 
> 1) Now, the documentation, when using SPHINXDIRS=media is not output
> at the Documentation/output/latex anymore, but, instead it created a
> Documentation/output/media/latex and wrote the books there.

Yes, we have not finished the discussion where all these outputs should
take place:

  https://www.mail-archive.com/linux-media@xxxxxxxxxxxxxxx/msg101572.html

ATM all sub-folder builds are placed in:

  Documentation/output/{sub-folder-name}

If someone has a proper solution, he can patch the make file.


> 2) If built without SPHINXDIRS, it is producing just one document and
> storing it at Documentation/output. I would expect it to do the same
> on both cases.

IMHO not .. I haven't change anything in the Documentation/conf.py

It is very simple: with SPHINXDIR, the latex_documents settings
from subdir's conf.py is used. Without, the ones from 
Documentation/conf.py is used.


> Btw, I'm planning to split the media documentation on 4 books even when
> building without SPHINXDIRS. There are two reasons for that:
> 
> 1) the uAPI book has a different licence than the other books;
> 
> 2) the uAPI book should be split into 5 parts, and each part should
> reset the chapter numberation to 1, in order to produce the same
> chapter numbering as the HTML book.
> 
> From what I saw, the control if LaTeX will use parts/chapter/section
> or just chapter section is controlled per conf.py file. It means that
> we'll need to have a separate conf.py for the uAPI book - or to have
> an Sphinx extension that would allow adjusting the LaTeX layout via
> some meta-tags at the book's index.rst.

Yes, top-level sectioning is for all latex_documents the same:

* http://www.sphinx-doc.org/en/stable/config.html#confval-latex_toplevel_sectioning

If you really need per-document top-level sectioning, we will find a solution.

-- Markus --

> 
> Regards,
> Mauro

--
To unsubscribe from this list: send the line "unsubscribe linux-media" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html



[Index of Archives]     [Linux Input]     [Video for Linux]     [Gstreamer Embedded]     [Mplayer Users]     [Linux USB Devel]     [Linux Audio Users]     [Linux Kernel]     [Linux SCSI]     [Yosemite Backpacking]
  Powered by Linux