Re: rst2pdf (was [PATCH 00/10] Documentation/Sphinx)

Path	csiph.com!news.mixmin.net!aioe.org!bofh.it!news.nic.it!robomod
From	Jani Nikula <jani.nikula@intel.com>
Newsgroups	linux.kernel
Subject	Re: rst2pdf (was [PATCH 00/10] Documentation/Sphinx)
Date	Tue, 07 Jun 2016 08:50:01 +0200
Message-ID	<rHiZP-7Do-9@gated-at.bofh.it> (permalink)
References	<rASYp-68P-3@gated-at.bofh.it> <rEfF8-2Ag-7@gated-at.bofh.it> <rErwD-2fk-55@gated-at.bofh.it> <rEsVI-2ZZ-11@gated-at.bofh.it> <rEwFX-5sh-3@gated-at.bofh.it> <rEyy6-6IE-47@gated-at.bofh.it> <rEBFD-B5-21@gated-at.bofh.it> <rG4cy-7ZV-7@gated-at.bofh.it> <rHin7-7mM-3@gated-at.bofh.it>
X-Original-To	Markus Heiser <markus.heiser@darmarit.de>, Jonathan Corbet <corbet@lwn.net>
X-Extloop1	1
X-Ironport-Av	E=Sophos;i="5.26,432,1459839600"; d="scan'208";a="996722356"
Organization	Intel Finland Oy - BIC 0357606-4 - Westendinkatu 7, 02160 Espoo
User-Agent	Notmuch/0.22+12~gbdd9442 (http://notmuchmail.org) Emacs/24.4.1 (x86_64-pc-linux-gnu)
MIME-Version	1.0
Content-Type	text/plain
Sender	robomod@news.nic.it
List-ID	<linux-kernel.vger.kernel.org>
X-Mailing-List	linux-kernel@vger.kernel.org
Approved	robomod@news.nic.it
Lines	38
X-Original-Cc	Daniel Vetter <daniel.vetter@ffwll.ch>, Grant Likely <grant.likely@secretlab.ca>, Mauro Carvalho Chehab <mchehab@osg.samsung.com>, Dan Allen <dan@opendevise.io>, Russel Winder <russel@winder.org.uk>, Keith Packard <keithp@keithp.com>, LKML <linux-kernel@vger.kernel.org>, linux-doc@vger.kernel.org, Hans Verkuil <hverkuil@xs4all.nl>
X-Original-Date	Tue, 07 Jun 2016 09:44:16 +0300
X-Original-Message-ID	<8760tl7b27.fsf@intel.com>
X-Original-References	<cover.1463748027.git.jani.nikula@intel.com> <877fec7gfm.fsf@intel.com> <CAKMK7uGSwf_jd2Nys=yArmA6voGmbyfTP4UAibswT4rU6yi75Q@mail.gmail.com> <36300F5F-C3F3-4A55-9257-788CF9F96CA4@darmarit.de> <878tyrbo36.fsf@intel.com> <5369C8B8-47F2-4B67-A314-5EB5471ABA00@darmarit.de> <87k2ibfh0x.fsf@intel.com> <20160603144732.18db8869@lwn.net> <1241B2AE-2257-4C72-97A1-D1D22D713442@darmarit.de>
X-Original-Sender	linux-kernel-owner@vger.kernel.org
Xref	csiph.com linux.kernel:1415753

Show key headers only | View raw

On Tue, 07 Jun 2016, Markus Heiser <markus.heiser@darmarit.de> wrote:
> I looked closer to rst2pdf, it supports only the docutils reST, but
> not the sphinx superset ...  
>
> <SNIP rst2pdf>-------------
> $ rst2pdf  index.rst
> index.rst:15: (ERROR/3) Unknown interpreted text role "ref".
> index.rst:15: (ERROR/3) Unknown interpreted text role "ref".
> index.rst:27: (ERROR/3) Unknown directive type "toctree".

This doesn't actually happen if you run rst2pdf through Sphinx.

> .. toctree::
>     :maxdepth: 1
>
>     kernel-doc-intro
>     kernel-doc-syntax
> <SNAP>-------------
>
>
> rules like ":ref:", domains like ":c:type:" and directives like ".. toctree:"
> are a part of the (extended) reST syntax from sphinx, thats why 
> standard docutils (like rst2*) will not work ...

You will get warnings like

[WARNING] styles.py:548 Using undefined style 'function', aliased to style 'normal'.
[WARNING] styles.py:548 Using undefined style 'type', aliased to style 'normal'.

but it's a matter of defining a custom rst2pdf stylesheet. It's json
with a sort of inheritance model, so it should be easy to just extend
the existing stylesheet.

BR,
Jani.

-- 
Jani Nikula, Intel Open Source Technology Center

Thread

Re: rst2pdf (was [PATCH 00/10] Documentation/Sphinx) Jonathan Corbet <corbet@lwn.net> - 2016-06-03 22:50 +0200
  Re: rst2pdf (was [PATCH 00/10] Documentation/Sphinx) Markus Heiser <markus.heiser@darmarit.de> - 2016-06-07 08:10 +0200
    Re: rst2pdf (was [PATCH 00/10] Documentation/Sphinx) Jani Nikula <jani.nikula@intel.com> - 2016-06-07 08:50 +0200
      Re: rst2pdf (was [PATCH 00/10] Documentation/Sphinx) Markus Heiser <markus.heiser@darmarit.de> - 2016-06-10 19:10 +0200

csiph-web