Re: Kernel docs: muddying the waters a bit

2016-05-03 Thread Keith Packard
Daniel Vetter writes: > So sphinx/rst y/n? Jon, is that ok with you from the doc maintainer > pov? I think the right answer for today is to use sphinx to generate docs From inline comments, to encourage outline docs to give it a try but to allow doc writers to use whatever works for them. That

Re: Kernel docs: muddying the waters a bit

2016-03-03 Thread Keith Packard
Mauro Carvalho Chehab writes: > On my tests, Sphinix seemed too limited to format tables. Asciidoc > produced an output that worked better. Yes, asciidoc has much more flexibility in table formatting, including the ability to control text layout within cells and full control over borders. Howev

Re: V4L docs and docbook

2016-02-19 Thread Keith Packard
Hans Verkuil writes: > But good table handling is a prerequisite for us since we rely heavily on > that. I converted an asciidoc document that included some tables to sphinx via docbook using pandoc; that seemed to generate workable results for me, but my needs are pretty simple. Asciidoc has

Re: Kernel docs: muddying the waters a bit

2016-02-16 Thread Keith Packard
Jonathan Corbet writes: > Indeed, I doubt many people want the DocBook itself. Might be nice to actually have a set of requirements before anyone tries to select a suitable system then :-) Here's my current set: asciidocsphinx htmlvia docbook native native (kin

Re: Kernel docs: muddying the waters a bit

2016-02-16 Thread Keith Packard
Jani Nikula writes: > 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.) A qui

Re: Kernel docs: muddying the waters a bit

2016-02-14 Thread Keith Packard
Daniel Vetter writes: > The other one is graphs - Keith showed me some neat stuff that > asciidoc can do, and I definitely wanted to integrate something like > that as a follow-up into the kerneldoc toolchain. Often a diagram is a > lot more helpful than lots of words. Can sphinx gives us that to

Re: Kernel docs: muddying the waters a bit

2016-02-13 Thread Keith Packard
Jonathan Corbet writes: > Asciidoc is a credible solution to the formatted documentation problem, > but it's not the only such; I'd like to be sure that we pick the right > one. I worry that asciidoc seems to be aimed mostly at small documents, > and that the project itself seems a little lifele

Re: [RFC] A first shot at asciidoc-based formatted docs

2016-02-12 Thread Keith Packard
Keith Packard writes: > The goal would be to create an html document which could be used without > javascript, and that would work without css as well. I've managed to hack up asciidoc to generate the TOC within the document, rather than requiring javascript. The changes are fairly

Re: [RFC] A first shot at asciidoc-based formatted docs

2016-02-11 Thread Keith Packard
Jani Nikula writes: > One of the chief complaints with the current pipeline (and some of the > proposals) has been the need to install lots of tools with lots of > dependencies. I would like to avoid the need to install bleeding edge > tools and stick to what's already widely available in distros

Re: [RFC] A first shot at asciidoc-based formatted docs

2016-02-11 Thread Keith Packard
Jonathan Corbet writes: > asciidoc->HTML on its own isn't viable, I think; we do have people wanting > other formats. Though one might well ask when somebody last successfully > generated PDF...maybe it's not worth the trouble. I would like epub > someday... I'm hopeful that I can hack up asci

Re: [RFC] A first shot at asciidoc-based formatted docs

2016-02-10 Thread Keith Packard
Jonathan Corbet writes: > [Adding Keith since you said you wanted to be a part of this - let us know > when you've had enough!] Thanks. > - I would like to format directly to HTML if at all possible. Agreed. asciidoc's docbook path seems to only increase the amount of software involved. >