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


Groups > linux.kernel > #1335133

Re: Kernel docs: muddying the waters a bit

From Jani Nikula <jani.nikula@intel.com>
Newsgroups linux.kernel
Subject Re: Kernel docs: muddying the waters a bit
Date 2016-02-16 09:30 +0100
Message-ID <r2Jbb-5ii-1@gated-at.bofh.it> (permalink)
References <r1Qoq-1Y5-17@gated-at.bofh.it>
Organization Intel Finland Oy - BIC 0357606-4 - Westendinkatu 7, 02160 Espoo

Show all headers | View raw


On Sat, 13 Feb 2016, Jonathan Corbet <corbet@lwn.net> wrote:
> So can we discuss?  I'm not saying we have to use Sphinx, but, should we
> choose not to, we should do so with open eyes and good reasons for the
> course we do take.  What do you all think?

FWIW I was in favor of reStructuredText to begin with, but decided I'd
rather have any lightweight markup than a bikeshed fest over which
one. Switching is a non-issue to me.

It does seem like the tools available for each markup carry more weight
than the markup itself, as long as there aren't any huge gaps. Sphinx
seems like a reasonable, actively developed choice.

However I didn't think Sphinx could produce docbook, and a quick search
doesn't convince me otherwise. Do you have some links to back this up?
Would the lack of docbook be a showstopper? (Of course, the pandoc
swiss-army knife can handle rst->docbook if needed.)

Sphinx might offer a way to drop docproc through the extension
mechanism, without resorting to the "separate-file approach". It might
be a more sensible approach as a whole.

I'll have a more in-depth look into this.

BR,
Jani.


-- 
Jani Nikula, Intel Open Source Technology Center

Back to linux.kernel | Previous | NextPrevious in thread | Next in thread | Find similar | Unroll thread


Thread

Kernel docs: muddying the waters a bit Jonathan Corbet <corbet@lwn.net> - 2016-02-13 23:00 +0100
  Re: Kernel docs: muddying the waters a bit Keith Packard <keithp@keithp.com> - 2016-02-14 02:00 +0100
    Re: Kernel docs: muddying the waters a bit Daniel Vetter <daniel.vetter@ffwll.ch> - 2016-02-14 13:30 +0100
      Re: Kernel docs: muddying the waters a bit Keith Packard <keithp@keithp.com> - 2016-02-14 17:30 +0100
      Re: Kernel docs: muddying the waters a bit Jonathan Corbet <corbet@lwn.net> - 2016-02-17 23:20 +0100
        Re: Kernel docs: muddying the waters a bit Daniel Vetter <daniel.vetter@ffwll.ch> - 2016-02-17 23:30 +0100
          Re: Kernel docs: muddying the waters a bit Jani Nikula <jani.nikula@intel.com> - 2016-02-18 10:20 +0100
            Re: Kernel docs: muddying the waters a bit Daniel Vetter <daniel.vetter@ffwll.ch> - 2016-02-18 10:30 +0100
              Re: Kernel docs: muddying the waters a bit Mauro Carvalho Chehab <mchehab@osg.samsung.com> - 2016-02-18 11:30 +0100
                Re: Kernel docs: muddying the waters a bit Jani Nikula <jani.nikula@intel.com> - 2016-02-18 12:30 +0100
                Re: Kernel docs: muddying the waters a bit Hans Verkuil <hverkuil@xs4all.nl> - 2016-02-18 13:10 +0100
                Re: Kernel docs: muddying the waters a bit Mauro Carvalho Chehab <mchehab@osg.samsung.com> - 2016-02-18 13:50 +0100
                Re: Kernel docs: muddying the waters a bit Patrick Boettcher <patrick.boettcher@posteo.de> - 2016-02-18 14:40 +0100
                Re: Kernel docs: muddying the waters a bit Mauro Carvalho Chehab <mchehab@osg.samsung.com> - 2016-02-18 13:10 +0100
              Re: Kernel docs: muddying the waters a bit Jonathan Corbet <corbet@lwn.net> - 2016-02-18 14:10 +0100
                Re: Kernel docs: muddying the waters a bit Daniel Vetter <daniel.vetter@ffwll.ch> - 2016-02-18 15:50 +0100
  Re: Kernel docs: muddying the waters a bit Jani Nikula <jani.nikula@intel.com> - 2016-02-16 09:30 +0100
    Re: Kernel docs: muddying the waters a bit Jonathan Corbet <corbet@lwn.net> - 2016-02-16 17:10 +0100
      Re: Kernel docs: muddying the waters a bit Jani Nikula <jani.nikula@intel.com> - 2016-02-16 18:20 +0100
    Re: Kernel docs: muddying the waters a bit Keith Packard <keithp@keithp.com> - 2016-02-16 20:20 +0100
      Re: Kernel docs: muddying the waters a bit Jonathan Corbet <corbet@lwn.net> - 2016-02-16 21:00 +0100
        Re: Kernel docs: muddying the waters a bit Keith Packard <keithp@keithp.com> - 2016-02-17 01:10 +0100

csiph-web