[RFC PATCH 3/3] doc-rst: customize RTD theme, captions & inline literal

From: Markus Heiser <markus.hei...@darmarit.de> To: Jonathan Corbet <cor...@lwn.net> To: Mauro Carvalho Chehab <mche...@osg.samsung.com> Cc: Hans Verkuil <hverk...@xs4all.nl> Cc: Daniel Vetter <daniel.vet...@ffwll.ch> Cc: Airlie <airl...@gmail.com> Cc: Likely &l

[RFC PATCH 1/3] doc-rst: boilerplate HTML theme customization

From: Markus Heiser To: Jonathan Corbet To: Mauro Carvalho Chehab Cc: Hans Verkuil Cc: Daniel Vetter Cc: Airlie Cc: Likely Cc: Dunlap Cc: Packard Cc: linux-...@vger.kernel.org Cc: linux-kernel@vger.kernel.org Implements the minimal boilerplate for Sphinx HTML theme customization. Signed

[RFC PATCH 3/3] doc-rst: customize RTD theme, captions & inline literal

From: Markus Heiser To: Jonathan Corbet To: Mauro Carvalho Chehab Cc: Hans Verkuil Cc: Daniel Vetter Cc: Airlie Cc: Likely Cc: Dunlap Cc: Packard Cc: linux-...@vger.kernel.org Cc: linux-kernel@vger.kernel.org The layout of (table) captions in the RTD theme is a bit ugly and the bordered

[RFC PATCH 0/3] doc-rst: customize HTML (RTD) theme

From: Markus Heiser <markus.hei...@darmarit.de> The default layout of the RTD HTML theme has some tweaks, discussed in the linux-doc ML [1][2]. This series adds a boilerplate to customize HTML themes and it fix the tweaks (mainly) for tables, captions and inline literals.

[RFC PATCH 0/3] doc-rst: customize HTML (RTD) theme

From: Markus Heiser The default layout of the RTD HTML theme has some tweaks, discussed in the linux-doc ML [1][2]. This series adds a boilerplate to customize HTML themes and it fix the tweaks (mainly) for tables, captions and inline literals. Since there is no (vast) table in Jon's docs-next

Re: [PATCH] doc: flat-table directive

Am 01.07.2016 um 14:58 schrieb Jonathan Corbet : > On Fri, 01 Jul 2016 13:44:17 +0300 > Jani Nikula wrote: > >> This is also one of the reasons why I so much want to keep everything >> behind one configuration file, and build everything in the Sphinx >>

Re: [PATCH] doc: flat-table directive

Am 01.07.2016 um 14:58 schrieb Jonathan Corbet : > On Fri, 01 Jul 2016 13:44:17 +0300 > Jani Nikula wrote: > >> This is also one of the reasons why I so much want to keep everything >> behind one configuration file, and build everything in the Sphinx >> toolchain. To keep it all more uniform,

Re: [PATCH] doc: flat-table directive

Am 01.07.2016 um 15:09 schrieb Jani Nikula <jani.nik...@intel.com>: > On Fri, 01 Jul 2016, Markus Heiser <markus.hei...@darmarit.de> wrote: >> In Sphinx, the code-block directive is a literal block, no refs or markup >> will be interpreted. This is different to what

Re: [PATCH] doc: flat-table directive

Am 01.07.2016 um 15:09 schrieb Jani Nikula : > On Fri, 01 Jul 2016, Markus Heiser wrote: >> In Sphinx, the code-block directive is a literal block, no refs or markup >> will be interpreted. This is different to what you know from DocBook. >> I will look for a soluti

Re: [docs-next PATCH] Documentation/sphinx: skip build if user requested specific DOCBOOKS

tional, and can be removed once we drop the DocBook > build. > > Cc: Markus Heiser <markus.hei...@darmarit.de> > Cc: Mauro Carvalho Chehab <mche...@osg.samsung.com> > Fixes: 22cba31bae9d ("Documentation/sphinx: add basic working Sphinx > configuration

Re: [docs-next PATCH] Documentation/sphinx: skip build if user requested specific DOCBOOKS

e we drop the DocBook > build. > > Cc: Markus Heiser > Cc: Mauro Carvalho Chehab > Fixes: 22cba31bae9d ("Documentation/sphinx: add basic working Sphinx > configuration and build") > Signed-off-by: Jani Nikula > --- > Documentation/Makefile.sphinx | 6

Re: [PATCH] doc: flat-table directive

Am 01.07.2016 um 11:38 schrieb Mauro Carvalho Chehab : > Btw, yesterday, I tried to add references to a C code, at video.rst, > just like we did with DocBook: > > .. code-block:: c > :caption: Example 2: Switching to the first video input > > int index; > >

Re: [PATCH] doc: flat-table directive

Am 01.07.2016 um 11:38 schrieb Mauro Carvalho Chehab : > Btw, yesterday, I tried to add references to a C code, at video.rst, > just like we did with DocBook: > > .. code-block:: c > :caption: Example 2: Switching to the first video input > > int index; > > index = 0; > > if (-1 ==

Re: [PATCH] doc: flat-table directive

Am 01.07.2016 um 13:56 schrieb Jani Nikula <jani.nik...@intel.com>: > On Fri, 01 Jul 2016, Markus Heiser <markus.hei...@darmarit.de> wrote: >> Am 01.07.2016 um 12:44 schrieb Jani Nikula <jani.nik...@intel.com>: >> >>> On Fri, 01 Jul 2016, Mauro Carva

Re: [PATCH] doc: flat-table directive

Am 01.07.2016 um 13:56 schrieb Jani Nikula : > On Fri, 01 Jul 2016, Markus Heiser wrote: >> Am 01.07.2016 um 12:44 schrieb Jani Nikula : >> >>> On Fri, 01 Jul 2016, Mauro Carvalho Chehab wrote: >>>> Not being able to compile just one docbook is a r

Re: [PATCH] doc: flat-table directive

Am 01.07.2016 um 12:44 schrieb Jani Nikula : > On Fri, 01 Jul 2016, Mauro Carvalho Chehab wrote: >> Not being able to compile just one docbook is a regression and breaks >> my process. This needs to be fixed. > > Do you have a regression with

Re: [PATCH] doc: flat-table directive

Am 01.07.2016 um 12:44 schrieb Jani Nikula : > On Fri, 01 Jul 2016, Mauro Carvalho Chehab wrote: >> Not being able to compile just one docbook is a regression and breaks >> my process. This needs to be fixed. > > Do you have a regression with *DocBook XML* on docs-next now? If yes, > clearly

Re: [PATCH] doc: flat-table directive

Am 30.06.2016 um 21:44 schrieb Mauro Carvalho Chehab : > Em Thu, 30 Jun 2016 13:05:11 -0600 > Jonathan Corbet escreveu: > >> Anyway, I don't want to delay this work, so I have gone ahead and applied >> it; > > Got already one issue... Maybe on Jeni's

Re: [PATCH] doc: flat-table directive

Am 30.06.2016 um 21:44 schrieb Mauro Carvalho Chehab : > Em Thu, 30 Jun 2016 13:05:11 -0600 > Jonathan Corbet escreveu: > >> Anyway, I don't want to delay this work, so I have gone ahead and applied >> it; > > Got already one issue... Maybe on Jeni's changes to the makefiles... > > I want

Re: [PATCH] doc: flat-table directive

Am 30.06.2016 um 21:05 schrieb Jonathan Corbet <cor...@lwn.net>: > On Thu, 30 Jun 2016 14:00:21 +0200 > Markus Heiser <markus.hei...@darmarit.de> wrote: > >> this is my flat-table patch on top of your docs-next branch / we discussed on >> the ML > > H

Re: [PATCH] doc: flat-table directive

Am 30.06.2016 um 21:05 schrieb Jonathan Corbet : > On Thu, 30 Jun 2016 14:00:21 +0200 > Markus Heiser wrote: > >> this is my flat-table patch on top of your docs-next branch / we discussed on >> the ML > > Hmm... we don't have an official kernel coding style for P

[PATCH] doc-rst: flat-table directive - initial implementation

implementation was taken from the sphkerneldoc project [1] [1] https://github.com/return42/sphkerneldoc/commits/master/scripts/site-python/linuxdoc/rstFlatTable.py Signed-off-by: Markus Heiser <markus.hei...@darmarit.de> --- Documentation/conf.py | 2 +- Documentation/

[PATCH] doc-rst: flat-table directive - initial implementation

implementation was taken from the sphkerneldoc project [1] [1] https://github.com/return42/sphkerneldoc/commits/master/scripts/site-python/linuxdoc/rstFlatTable.py Signed-off-by: Markus Heiser --- Documentation/conf.py | 2 +- Documentation/kernel-documentation.rst | 85

[PATCH] doc: flat-table directive

Hi Jonathan, this is my flat-table patch on top of your docs-next branch / we discussed on the ML[1] [1] http://mid.gmane.org/573d454c-2f55-4dd7-9c16-00b3897ae...@darmarit.de Markus Heiser (1): doc-rst: flat-table directive - initial implementation Documentation/conf.py

[PATCH] doc: flat-table directive

Hi Jonathan, this is my flat-table patch on top of your docs-next branch / we discussed on the ML[1] [1] http://mid.gmane.org/573d454c-2f55-4dd7-9c16-00b3897ae...@darmarit.de Markus Heiser (1): doc-rst: flat-table directive - initial implementation Documentation/conf.py

Re: [GIT PULL] doc: sphinx-4.8 DocBook to reST movement on Jon's docs-next

Am 29.06.2016 um 22:57 schrieb Mauro Carvalho Chehab : > Em Wed, 29 Jun 2016 11:52:09 -0600 > Jonathan Corbet escreveu: > >>> 2. What is the best way to ship these migrations >>> >>> or better I asked, what is your recommendation for a >>> migration

Re: [GIT PULL] doc: sphinx-4.8 DocBook to reST movement on Jon's docs-next

Am 29.06.2016 um 22:57 schrieb Mauro Carvalho Chehab : > Em Wed, 29 Jun 2016 11:52:09 -0600 > Jonathan Corbet escreveu: > >>> 2. What is the best way to ship these migrations >>> >>> or better I asked, what is your recommendation for a >>> migration strategy. Jani says, that this better

Re: [GIT PULL] doc: sphinx-4.8 DocBook to reST movement on Jon's docs-next

Hi Jonathan, Am 29.06.2016 um 19:52 schrieb Jonathan Corbet <cor...@lwn.net>: > On Wed, 29 Jun 2016 19:35:46 +0200 > Markus Heiser <markus.hei...@darmarit.de> wrote: > >>> I would love it if you would take the flat-table and man-page work, >>>

Re: [GIT PULL] doc: sphinx-4.8 DocBook to reST movement on Jon's docs-next

Hi Jonathan, Am 29.06.2016 um 19:52 schrieb Jonathan Corbet : > On Wed, 29 Jun 2016 19:35:46 +0200 > Markus Heiser wrote: > >>> I would love it if you would take the flat-table and man-page work, >>> separate them out, and make them work with the *existing* Sphinx-ba

Re: [GIT PULL] doc: sphinx-4.8 DocBook to reST movement on Jon's docs-next

Hi Jonathan, Am 29.06.2016 um 18:24 schrieb Jonathan Corbet : > Hi, Markus, > > I was glad to hear from you, but I have to agree with Jani: this is not > how things are done. Consider this one line: > >> 706 files changed, 123369 insertions(+), 752 deletions(-) > > Something

Re: [GIT PULL] doc: sphinx-4.8 DocBook to reST movement on Jon's docs-next

Hi Jonathan, Am 29.06.2016 um 18:24 schrieb Jonathan Corbet : > Hi, Markus, > > I was glad to hear from you, but I have to agree with Jani: this is not > how things are done. Consider this one line: > >> 706 files changed, 123369 insertions(+), 752 deletions(-) > > Something like that will

Re: [GIT PULL] doc: sphinx-4.8 DocBook to reST movement on Jon's docs-next

Am 29.06.2016 um 15:15 schrieb Jani Nikula <jani.nik...@intel.com>: > On Wed, 29 Jun 2016, Markus Heiser <markus.hei...@darmarit.de> wrote: >> Am 28.06.2016 um 21:05 schrieb Jani Nikula <jani.nik...@intel.com>: >>> Perhaps you misunderstood, I don't know. Whe

Re: [GIT PULL] doc: sphinx-4.8 DocBook to reST movement on Jon's docs-next

Am 29.06.2016 um 15:15 schrieb Jani Nikula : > On Wed, 29 Jun 2016, Markus Heiser wrote: >> Am 28.06.2016 um 21:05 schrieb Jani Nikula : >>> Perhaps you misunderstood, I don't know. When we ask you to rebase your >>> work on something, in this case docs-next, it gener

Re: [PATCH 00/10] Documentation/Sphinx

Am 27.06.2016 um 19:08 schrieb Mauro Carvalho Chehab <mche...@osg.samsung.com>: > Em Mon, 27 Jun 2016 08:15:28 +0200 > Markus Heiser <markus.hei...@darmarit.de> escreveu: > >> Am 24.06.2016 um 12:40 schrieb Mauro Carvalho Chehab >> <mche...@osg.samsung.com

Re: [PATCH 00/10] Documentation/Sphinx

Am 27.06.2016 um 19:08 schrieb Mauro Carvalho Chehab : > Em Mon, 27 Jun 2016 08:15:28 +0200 > Markus Heiser escreveu: > >> Am 24.06.2016 um 12:40 schrieb Mauro Carvalho Chehab >> : >> >>> Em Tue, 31 May 2016 12:16:25 +0200 >>> Markus Heiser escre

Re: [GIT PULL] doc: sphinx-4.8 DocBook to reST movement on Jon's docs-next

Am 28.06.2016 um 21:05 schrieb Jani Nikula <jani.nik...@intel.com>: > On Tue, 28 Jun 2016, Markus Heiser <markus.hei...@darmarit.de> wrote: >> Hi Jonathan, hi Mauro, >> >> here is my DocBook to reST movement on top of Jon's docs-next branch. It >&g

Re: [GIT PULL] doc: sphinx-4.8 DocBook to reST movement on Jon's docs-next

Am 28.06.2016 um 21:05 schrieb Jani Nikula : > On Tue, 28 Jun 2016, Markus Heiser wrote: >> Hi Jonathan, hi Mauro, >> >> here is my DocBook to reST movement on top of Jon's docs-next branch. It >> includes: >> >> * kernel-doc parser & directive >

[GIT PULL] doc: sphinx-4.8 DocBook to reST movement on Jon's docs-next

8 +0200) ---- Markus Heiser (15): python: add scripts/site-packages kernel-doc-HOWTO: add kernel-doc specification doc-rst: add python package linuxdoc doc-rst: kernel-doc parser - inital python implementation

[GIT PULL] doc: sphinx-4.8 DocBook to reST movement on Jon's docs-next

8 +0200) ---- Markus Heiser (15): python: add scripts/site-packages kernel-doc-HOWTO: add kernel-doc specification doc-rst: add python package linuxdoc doc-rst: kernel-doc parser - inital python implementation

Re: [PATCH 00/10] Documentation/Sphinx

Am 24.06.2016 um 12:40 schrieb Mauro Carvalho Chehab <mche...@osg.samsung.com>: > Em Tue, 31 May 2016 12:16:25 +0200 > Markus Heiser <markus.hei...@darmarit.de> escreveu: > >> Am 30.05.2016 um 23:23 schrieb Mauro Carvalho Chehab >> <mche...@osg.samsung.com

Re: [PATCH 00/10] Documentation/Sphinx

Am 24.06.2016 um 12:40 schrieb Mauro Carvalho Chehab : > Em Tue, 31 May 2016 12:16:25 +0200 > Markus Heiser escreveu: > >> Am 30.05.2016 um 23:23 schrieb Mauro Carvalho Chehab >> : >> >>> Em Mon, 30 May 2016 23:05:34 +0300 >>> Jani Niku

Re: [PATCH 0/7] add reST/sphinx-doc to linux documentation

FYI Am 07.06.2016 um 09:54 schrieb Daniel Vetter <daniel.vet...@ffwll.ch>: > On Mon, Jun 6, 2016 at 6:32 PM, Markus Heiser <markus.hei...@darmarit.de> > wrote: >> From: "Heiser, Markus" <markus.hei...@darmarit.de> >> > I'm still not s

Re: [PATCH 0/7] add reST/sphinx-doc to linux documentation

FYI Am 07.06.2016 um 09:54 schrieb Daniel Vetter : > On Mon, Jun 6, 2016 at 6:32 PM, Markus Heiser > wrote: >> From: "Heiser, Markus" >> > I'm still not sold on the vintage-kerneldoc idea. At least in my > experience (after first converting to asciidoc

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

Am 07.06.2016 um 08:44 schrieb Jani Nikula <jani.nik...@intel.com>: > On Tue, 07 Jun 2016, Markus Heiser <markus.hei...@darmarit.de> wrote: >> I looked closer to rst2pdf, it supports only the docutils reST, but >> not the sphinx superset ... >> >>

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

Am 07.06.2016 um 08:44 schrieb Jani Nikula : > On Tue, 07 Jun 2016, Markus Heiser wrote: >> I looked closer to rst2pdf, it supports only the docutils reST, but >> not the sphinx superset ... >> >> - >> $ rst2pdf index.rst >> index.rst:15:

Re: [PATCH 3/7] kernel-doc-HOWTO: add kernel-doc specification

Hi Randy, thanks for your amendments / has been fixed [1] [1] https://github.com/return42/linux/commit/98a9fc42cbd0c23b266ac28494dafe20d7920d05 Am 09.06.2016 um 20:05 schrieb Randy Dunlap : > Hi, > > Some spellos and a few questions... >> +

Re: [PATCH 3/7] kernel-doc-HOWTO: add kernel-doc specification

Hi Randy, thanks for your amendments / has been fixed [1] [1] https://github.com/return42/linux/commit/98a9fc42cbd0c23b266ac28494dafe20d7920d05 Am 09.06.2016 um 20:05 schrieb Randy Dunlap : > Hi, > > Some spellos and a few questions... >> +

[GIT PULL] add reST/sphinx-doc to linux documentation

) Markus Heiser (20): python: add scripts/site-packages sphinx-doc: add basic sphinx-build infrastructure kernel-doc-HOWTO: add kernel-doc specification linuxdoc: add python package linuxdoc kernel-doc parser: inital python

[GIT PULL] add reST/sphinx-doc to linux documentation

) Markus Heiser (20): python: add scripts/site-packages sphinx-doc: add basic sphinx-build infrastructure kernel-doc-HOWTO: add kernel-doc specification linuxdoc: add python package linuxdoc kernel-doc parser: inital python

Re: [PATCH 0/7] add reST/sphinx-doc to linux documentation

Am 08.06.2016 um 21:49 schrieb Jonathan Corbet : > So I've finally gotten a chance to make another pass over this stuff. > > Markus, your enthusiasm is great; I'm hoping you'll do great things > helping us to improve the kernel's documentation toolchain. With 7 years DocBook

Re: [PATCH 0/7] add reST/sphinx-doc to linux documentation

Am 08.06.2016 um 21:49 schrieb Jonathan Corbet : > So I've finally gotten a chance to make another pass over this stuff. > > Markus, your enthusiasm is great; I'm hoping you'll do great things > helping us to improve the kernel's documentation toolchain. With 7 years DocBook and 8 years reST

Re: [PATCH 0/7] add reST/sphinx-doc to linux documentation

Am 07.06.2016 um 13:09 schrieb Jani Nikula <jani.nik...@intel.com>: > On Tue, 07 Jun 2016, Markus Heiser <markus.hei...@darmarit.de> wrote: >> Am 07.06.2016 um 10:59 schrieb Jani Nikula <jani.nik...@intel.com>: >>> One of the key arguments against

Re: [PATCH 0/7] add reST/sphinx-doc to linux documentation

Am 07.06.2016 um 13:09 schrieb Jani Nikula : > On Tue, 07 Jun 2016, Markus Heiser wrote: >> Am 07.06.2016 um 10:59 schrieb Jani Nikula : >>> One of the key arguments against too much splitting that hasn't been >>> mentioned is that despite all the fine output Sphi

Re: [PATCH 0/7] add reST/sphinx-doc to linux documentation

06.06.2016 um 18:32 schrieb Markus Heiser <markus.hei...@darmarit.de>: > From: "Heiser, Markus" <markus.hei...@darmarit.de> > > Hi Jonathan, Jani, all - > > I merged the work from sphkerneldoc POC [1], into branch (on v4.7-rc2) > >git://g

Re: [PATCH 0/7] add reST/sphinx-doc to linux documentation

06.06.2016 um 18:32 schrieb Markus Heiser : > From: "Heiser, Markus" > > Hi Jonathan, Jani, all - > > I merged the work from sphkerneldoc POC [1], into branch (on v4.7-rc2) > >git://github.com/return42/linux.git linux-doc-reST > > The specificat

Re: [PATCH 0/7] add reST/sphinx-doc to linux documentation

Am 07.06.2016 um 10:59 schrieb Jani Nikula : > On Tue, 07 Jun 2016, Daniel Vetter wrote: >> I think getting the flat-table directive landed would be great. We >> have a similarly annoying table in gpu.tmpl where the ascii-art tables >> fall short

Re: [PATCH 0/7] add reST/sphinx-doc to linux documentation

Am 07.06.2016 um 10:59 schrieb Jani Nikula : > On Tue, 07 Jun 2016, Daniel Vetter wrote: >> I think getting the flat-table directive landed would be great. We >> have a similarly annoying table in gpu.tmpl where the ascii-art tables >> fall short and are annoying. We want to split it up, but

Re: [PATCH 0/7] add reST/sphinx-doc to linux documentation

Am 07.06.2016 um 09:54 schrieb Daniel Vetter <daniel.vet...@ffwll.ch>: > On Mon, Jun 6, 2016 at 6:32 PM, Markus Heiser <markus.hei...@darmarit.de> > wrote: >> From: "Heiser, Markus" <markus.hei...@darmarit.de> >> >> Hi Jonathan, Jani, all

Re: [PATCH 0/7] add reST/sphinx-doc to linux documentation

Am 07.06.2016 um 09:54 schrieb Daniel Vetter : > On Mon, Jun 6, 2016 at 6:32 PM, Markus Heiser > wrote: >> From: "Heiser, Markus" >> >> Hi Jonathan, Jani, all - >> >> I merged the work from sphkerneldoc POC [1], into branch (on v4.7-rc2) >&

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

xdepth: 1 kernel-doc-intro kernel-doc-syntax - 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 ... >

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

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 ... > Am 18.04.2016 um 10:10 schrieb Markus Heiser : > Re: Kerne

[PATCH 1/7] python: add scripts/site-packages

ages Signed-off-by: Markus Heiser <markus.hei...@darmarit.de> --- scripts/site-python/.gitignore | 1 + scripts/site-python/README | 14 ++ 2 files changed, 15 insertions(+) create mode 100644 scripts/site-python/.gitignore create mode 100644 scripts/site-python/README

[PATCH 1/7] python: add scripts/site-packages

d from any python script. If you are unfamiliar with python packages consult [3] at least. [1] https://docs.python.org/3/using/cmdline.html#envvar-PYTHONPATH [2] https://docs.python.org/3/install/#inst-search-path [3] https://docs.python.org/3/tutorial/modules.html#packages Signed-off-by: Mar

[PATCH 0/7] add reST/sphinx-doc to linux documentation

From: "Heiser, Markus" Hi Jonathan, Jani, all - I merged the work from sphkerneldoc POC [1], into branch (on v4.7-rc2) git://github.com/return42/linux.git linux-doc-reST The specification of the implementation is the (new) kernel-doc-HOWTO book which is a part

[PATCH 0/7] add reST/sphinx-doc to linux documentation

From: "Heiser, Markus" Hi Jonathan, Jani, all - I merged the work from sphkerneldoc POC [1], into branch (on v4.7-rc2) git://github.com/return42/linux.git linux-doc-reST The specification of the implementation is the (new) kernel-doc-HOWTO book which is a part of the patch series (also

[PATCH 7/7] flat-table directive: initial implementation

turn42.github.io/sphkerneldoc/books/kernel-doc-HOWTO/table-markup.html#flat-table [2] http://docutils.sourceforge.net/docs/ref/rst/directives.html#list-table [3] http://return42.github.io/sphkerneldoc Signed-off-by: Markus Heiser <markus.hei...@darmarit.de> --- scripts/site-python/linuxdoc

[PATCH 7/7] flat-table directive: initial implementation

oks/kernel-doc-HOWTO/table-markup.html#flat-table [2] http://docutils.sourceforge.net/docs/ref/rst/directives.html#list-table [3] http://return42.github.io/sphkerneldoc Signed-off-by: Markus Heiser --- scripts/site-python/linuxdoc/rstFlatTable.py | 356 +++ 1 file ch

[PATCH 5/7] kernel-doc parser: inital python implementation

uses this module, the documentation generation becomes much more clear and flexible. [1] http://return42.github.io/sphkerneldoc/books/kernel-doc-HOWTO Signed-off-by: Markus Heiser <markus.hei...@darmarit.de> --- scripts/site-python/linuxdoc/kernel_doc.py | 2764 1 file ch

[PATCH 5/7] kernel-doc parser: inital python implementation

generation becomes much more clear and flexible. [1] http://return42.github.io/sphkerneldoc/books/kernel-doc-HOWTO Signed-off-by: Markus Heiser --- scripts/site-python/linuxdoc/kernel_doc.py | 2764 1 file changed, 2764 insertions(+) create mode 100755 scripts/site-pytho

[PATCH 2/7] sphinx-doc: add basic sphinx-build infrastructure

turn42.github.io/sphkerneldoc Signed-off-by: Markus Heiser <markus.hei...@darmarit.de> --- Documentation/.gitignore| 2 + Documentation/Makefile.reST | 111 Documentation/books/.gitignore | 0

[PATCH 2/7] sphinx-doc: add basic sphinx-build infrastructure

Signed-off-by: Markus Heiser --- Documentation/.gitignore| 2 + Documentation/Makefile.reST | 111 Documentation/books/.gitignore | 0 Documentation/conf.py | 357 Documentat

[PATCH 4/7] linuxdoc: add python package linuxdoc

From: "Heiser, Markus" <markus.hei...@darmarit.de> The linuxdoc package includes python extensions related to the linux documentation processes. Signed-off-by: Markus Heiser <markus.hei...@darmarit.de> --- scripts/site-python/linuxdoc/__init__.py | 8 1 file

[PATCH 4/7] linuxdoc: add python package linuxdoc

From: "Heiser, Markus" The linuxdoc package includes python extensions related to the linux documentation processes. Signed-off-by: Markus Heiser --- scripts/site-python/linuxdoc/__init__.py | 8 1 file changed, 8 insertions(+) create mode 100644 scripts/site-pytho

[PATCH 3/7] kernel-doc-HOWTO: add kernel-doc specification

efer and extract documentation from source files. A online kernel-doc-HOWTO is available at [1] [1] http://return42.github.io/sphkerneldoc/books/kernel-doc-HOWTO Signed-off-by: Markus Heiser <markus.hei...@darmarit.de> --- Documentation/books/kernel-doc-HOWTO.conf | 200 + .../

[PATCH 3/7] kernel-doc-HOWTO: add kernel-doc specification

urce files. A online kernel-doc-HOWTO is available at [1] [1] http://return42.github.io/sphkerneldoc/books/kernel-doc-HOWTO Signed-off-by: Markus Heiser --- Documentation/books/kernel-doc-HOWTO.conf | 200 + .../books/kernel-doc-HOWTO/all-in-a-tumble-src.rst | 12 + .../books/

[PATCH 6/7] kernel-doc directive: initial implementation

turn42.github.io/sphkerneldoc Signed-off-by: Markus Heiser <markus.hei...@darmarit.de> --- scripts/site-python/linuxdoc/rstKernelDoc.py | 369 +++ 1 file changed, 369 insertions(+) create mode 100755 scripts/site-python/linuxdoc/rstKernelDoc.py diff --git a/script

[PATCH 6/7] kernel-doc directive: initial implementation

Signed-off-by: Markus Heiser --- scripts/site-python/linuxdoc/rstKernelDoc.py | 369 +++ 1 file changed, 369 insertions(+) create mode 100755 scripts/site-python/linuxdoc/rstKernelDoc.py diff --git a/scripts/site-python/linuxdoc/rstKernelDoc.py b/scripts/site-pytho

Re: [PATCH 05/10] Documentation/sphinx: add Sphinx kernel-doc directive extension

Am 03.06.2016 um 22:35 schrieb Jonathan Corbet : > On Fri, 20 May 2016 16:39:36 +0300 > Jani Nikula wrote: > >> Add an extension to handle kernel-doc directives, to call kernel-doc >> according to the arguments and parameters given to the reStructuredText

Re: [PATCH 05/10] Documentation/sphinx: add Sphinx kernel-doc directive extension

Am 03.06.2016 um 22:35 schrieb Jonathan Corbet : > On Fri, 20 May 2016 16:39:36 +0300 > Jani Nikula wrote: > >> Add an extension to handle kernel-doc directives, to call kernel-doc >> according to the arguments and parameters given to the reStructuredText >> directive. >> >> The syntax for

Re: [PATCH 00/10] Documentation/Sphinx

Am 31.05.2016 um 12:30 schrieb Jani Nikula <jani.nik...@intel.com>: > On Tue, 31 May 2016, Markus Heiser <markus.hei...@darmarit.de> wrote: >> Am 31.05.2016 um 10:07 schrieb Daniel Vetter <daniel.vet...@ffwll.ch>: >>> 0-day builds all docs, and chec

Re: [PATCH 00/10] Documentation/Sphinx

Am 31.05.2016 um 12:30 schrieb Jani Nikula : > On Tue, 31 May 2016, Markus Heiser wrote: >> Am 31.05.2016 um 10:07 schrieb Daniel Vetter : >>> 0-day builds all docs, and checks for new warnings. Even in today's >>> gpu.tmpl build there's a massive pile of warnings,

Re: [PATCH 00/10] Documentation/Sphinx

Am 30.05.2016 um 23:23 schrieb Mauro Carvalho Chehab : > Em Mon, 30 May 2016 23:05:34 +0300 > Jani Nikula escreveu: > >>> I worry a little bit in that reST will be only one more toolchain >>> beside DocBook .. in the long term, kernel's

Re: [PATCH 00/10] Documentation/Sphinx

Am 30.05.2016 um 23:23 schrieb Mauro Carvalho Chehab : > Em Mon, 30 May 2016 23:05:34 +0300 > Jani Nikula escreveu: > >>> I worry a little bit in that reST will be only one more toolchain >>> beside DocBook .. in the long term, kernel's documentation >>> should get rid of all the DocBook

Re: [PATCH 00/10] Documentation/Sphinx

Am 31.05.2016 um 10:07 schrieb Daniel Vetter <daniel.vet...@ffwll.ch>: > On Tue, May 31, 2016 at 9:27 AM, Markus Heiser > <markus.hei...@darmarit.de> wrote: >>>>> I find it totally unacceptable to require explicitly marking kernel-doc >>>>> co

Re: [PATCH 00/10] Documentation/Sphinx

Am 31.05.2016 um 10:07 schrieb Daniel Vetter : > On Tue, May 31, 2016 at 9:27 AM, Markus Heiser > wrote: >>>>> I find it totally unacceptable to require explicitly marking kernel-doc >>>>> comments or source files as being reStructuredText. >>>>

Re: [PATCH 00/10] Documentation/Sphinx

Am 30.05.2016 um 22:05 schrieb Jani Nikula <jani.nik...@intel.com>: > On Mon, 30 May 2016, Markus Heiser <markus.hei...@darmarit.de> wrote: >> Am 30.05.2016 um 16:46 schrieb Jani Nikula <jani.nik...@intel.com>: >>> I am not proposing to merge the

Re: [PATCH 00/10] Documentation/Sphinx

Am 30.05.2016 um 22:05 schrieb Jani Nikula : > On Mon, 30 May 2016, Markus Heiser wrote: >> Am 30.05.2016 um 16:46 schrieb Jani Nikula : >>> I am not proposing to merge the documents that I've converted mostly as >>> samples in the branch. I needed something to demons

Re: [PATCH 00/10] Documentation/Sphinx

Am 30.05.2016 um 16:46 schrieb Jani Nikula <jani.nik...@intel.com>: > On Mon, 30 May 2016, Markus Heiser <markus.hei...@darmarit.de> wrote: >> Here my 5cents about Jani's patch series: >> >> 1. Migration implementations should not be a part of the ker

Re: [PATCH 00/10] Documentation/Sphinx

Am 30.05.2016 um 16:46 schrieb Jani Nikula : > On Mon, 30 May 2016, Markus Heiser wrote: >> Here my 5cents about Jani's patch series: >> >> 1. Migration implementations should not be a part of the kernel tree > > If you're referring to the conversion scripts, I do

Re: [PATCH 00/10] Documentation/Sphinx

Hi, sorry for my temporary absence, I have been on holiday the last weeks :-) Am 30.05.2016 um 11:10 schrieb Daniel Vetter : > On Sun, May 29, 2016 at 10:33 PM, Jani Nikula wrote: >> On Fri, 20 May 2016, Jani Nikula wrote:

Re: [PATCH 00/10] Documentation/Sphinx

Hi, sorry for my temporary absence, I have been on holiday the last weeks :-) Am 30.05.2016 um 11:10 schrieb Daniel Vetter : > On Sun, May 29, 2016 at 10:33 PM, Jani Nikula wrote: >> On Fri, 20 May 2016, Jani Nikula wrote: >>> At this time I've put most effort into the configuration and build

Re: Kernel docs: muddying the waters a bit

Hi Mauro, Am 06.05.2016 um 13:03 schrieb Mauro Carvalho Chehab : > Yeah, it looks better, however table truncation seem to be > happening also on other parts, like the tables on this page: > > >

Re: Kernel docs: muddying the waters a bit

Hi Mauro, Am 06.05.2016 um 13:03 schrieb Mauro Carvalho Chehab : > Yeah, it looks better, however table truncation seem to be > happening also on other parts, like the tables on this page: > > > https://return42.github.io/sphkerneldoc/books/linux_tv/media/v4l/pixfmt-packed-rgb.html >

Re: Kernel docs: muddying the waters a bit

Am 06.05.2016 um 17:06 schrieb Jani Nikula <jani.nik...@intel.com>: > On Fri, 06 May 2016, Markus Heiser <markus.hei...@darmarit.de> wrote: >> @Jonathan: what do you think? Should I prepare a patch >> with a basic reST (sphinx) build infrastructure, including >&g

Re: Kernel docs: muddying the waters a bit

Am 06.05.2016 um 17:06 schrieb Jani Nikula : > On Fri, 06 May 2016, Markus Heiser wrote: >> @Jonathan: what do you think? Should I prepare a patch >> with a basic reST (sphinx) build infrastructure, including >> >> * a folder for sphinx docs: >> >> .

Re: Kernel docs: muddying the waters a bit

Hi all, hi Jonathan, Am 06.05.2016 um 15:42 schrieb Mauro Carvalho Chehab <mche...@osg.samsung.com>: > Em Fri, 6 May 2016 15:32:35 +0200 > Markus Heiser <markus.hei...@darmarit.de> escreveu: > >> Hi Mauro, >> >> Am 06.05.2016 um 13:35 schrieb Mauro Carva

Re: Kernel docs: muddying the waters a bit

Hi all, hi Jonathan, Am 06.05.2016 um 15:42 schrieb Mauro Carvalho Chehab : > Em Fri, 6 May 2016 15:32:35 +0200 > Markus Heiser escreveu: > >> Hi Mauro, >> >> Am 06.05.2016 um 13:35 schrieb Mauro Carvalho Chehab >> : >> >>> Markus, >&

Re: Kernel docs: muddying the waters a bit

comments twice. -- Markus-- Am 06.05.2016 um 13:23 schrieb Markus Heiser <markus.hei...@darmarit.de>: > > Hy Jani, > > Am 04.05.2016 um 18:13 schrieb Jani Nikula <jani.nik...@intel.com>: > >>> Am 04.05.2016 um 17:09 schrieb Jonathan Corbet <

Re: Kernel docs: muddying the waters a bit

comments twice. -- Markus-- Am 06.05.2016 um 13:23 schrieb Markus Heiser : > > Hy Jani, > > Am 04.05.2016 um 18:13 schrieb Jani Nikula : > >>> Am 04.05.2016 um 17:09 schrieb Jonathan Corbet : >>> >>>> I think all of this makes sense. It wou

Re: Kernel docs: muddying the waters a bit

Hy Jani, Am 04.05.2016 um 18:13 schrieb Jani Nikula : >> Am 04.05.2016 um 17:09 schrieb Jonathan Corbet : >> >>> I think all of this makes sense. It would be really nice to have the >>> directives in the native sphinx language like that. I *don't* think

<    1   2   3   4   >