lkml.org 
[lkml]   [2016]   [Nov]   [21]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
SubjectRe: [Ksummit-discuss] Including images on Sphinx documents
From
Date
On Mon, 2016-11-21 at 12:06 -0200, Mauro Carvalho Chehab wrote:
> Em Mon, 21 Nov 2016 11:39:41 +0100
> Johannes Berg <johannes@sipsolutions.net> escreveu:
> > On Sat, 2016-11-19 at 10:15 -0700, Jonathan Corbet wrote:
> >
> > > Rather than beating our heads against the wall trying to convert
> > > between various image formats, maybe we need to take a step
> > > back. We're trying to build better documentation, and there is
> > > certainly a place for diagrams and such in that
> > > documentation. Johannes was asking about it for the 802.11 docs,
> > > and I know Paul has run into these issues with the RCU docs as
> > > well. Might there be a tool or an extension out there that would
> > > allow us to express these diagrams in a text-friendly, editable
> > > form?
> > >
> > > With some effort, I bet we could get rid of a number of the
> > > images, and perhaps end up with something that makes sense when
> > > read in the .rst source files as an extra benefit.
> >
> > I tend to agree, and I think that having this readable in the text
> > would be good.
> >
> > You had pointed me to this plugin before
> > https://pythonhosted.org/sphinxcontrib-aafig/
> >
> > but I don't think it can actually represent any of the pictures.
>
> No, but there are some ascii art images inside some txt/rst files
> and inside some kernel-doc comments. We could either use the above
> extension for them or to convert into some image. The ascii art
> images I saw seem to be diagrams, so Graphviz would allow replacing
> most of them, if not all.

Please don't replace ASCII art that effectively conveys conceptual
diagrams. If you do, we'll wind up in situations where someone hasn't
built the docs and doesn't possess the tools to see a diagram that was
previously shown by every text editor (or can't be bothered to dig out
the now separate file). In the name of creating "prettier" diagrams
(and final doc), we'll have damaged capacity to understand stuff by
just reading the source if this diagram is in kernel doc comments. I
think this is a good application of "if it ain't broke, don't fix it".

James

\
 
 \ /
  Last update: 2016-11-21 16:42    [W:0.117 / U:0.076 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site