[lkml]   [2018]   [Jul]   [20]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
Messages in this thread
SubjectRe: Sphinx version dependencies?
Am Freitag, den 20.07.2018, 09:12 -0400 schrieb Theodore Y. Ts'o:
> I'm not entirely sure what's the best approach. Right now I just want
> to understand --- do I have to make ext4.rst work against one, or many
> versions of Sphinx? And which version(s) of Sphinx do I need to
> concern myself with? If that turns out to be an onerous burden, I'm
> sure I won't be the only person complaining. :-)

In that case ...

> But when I did that, Sphinx had heartburn over the ext4.rst file.
> ./include/linux/spi/spi.h:373: ERROR: Unexpected indentation.
> /usr/projects/linux/ext4/Documentation/filesystems/ext4/ext4.rst:139: ERROR: Malformed table.
> Column span alignment problem in table line 5.

... its clear; the table was malformed. A markup error which is not detected
by older versions of docutils (very special case).

In general I recommend to install an up-to-date Sphinx-doc in a virtualenv .. this
is what I do in my projects ... and where I haven't seen those version problems ;)

If we have errors downward we have to handle them. The main thing is the markup
is correct.

-- Markus --

 \ /
  Last update: 2018-07-20 15:46    [W:0.115 / U:5.552 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site