From: Markus Heiser <markus.heiser@darmarit.de>
To: "Theodore Y. Ts'o" <tytso@mit.edu>
Cc: "Darrick J. Wong" <darrick.wong@oracle.com>,
Jonathan Corbet <corbet@lwn.net>,
linux-doc@vger.kernel.org, linux-ext4@vger.kernel.org,
linux-kernel@vger.kernel.org
Subject: Re: Sphinx version dependencies?
Date: Fri, 20 Jul 2018 15:45:37 +0200 [thread overview]
Message-ID: <d064f468ab9fc60a02242331e0dddc185d6556ba.camel@darmarit.de> (raw)
In-Reply-To: <20180720131206.GM30706@thunk.org>
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 --
next prev parent reply other threads:[~2018-07-20 13:45 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <20180719181556.GA21435@thunk.org>
[not found] ` <20180719190400.GB4800@magnolia>
2018-07-20 7:30 ` Sphinx version dependencies? Markus Heiser
2018-07-20 13:12 ` Theodore Y. Ts'o
2018-07-20 13:45 ` Markus Heiser [this message]
2018-07-20 14:52 ` Theodore Y. Ts'o
2018-07-20 16:00 ` Markus Heiser
2018-07-20 16:44 ` Darrick J. Wong
2018-07-20 16:58 ` Markus Heiser
2018-07-20 17:10 ` Darrick J. Wong
2018-07-20 20:43 ` Theodore Y. Ts'o
2018-07-20 21:28 ` Markus Heiser
2018-07-21 10:38 ` Jonathan Corbet
2018-07-20 15:04 ` Christoph Hellwig
2018-07-20 16:28 ` Markus Heiser
2018-07-20 17:08 ` Darrick J. Wong
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=d064f468ab9fc60a02242331e0dddc185d6556ba.camel@darmarit.de \
--to=markus.heiser@darmarit.de \
--cc=corbet@lwn.net \
--cc=darrick.wong@oracle.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-ext4@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=tytso@mit.edu \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).