From mboxrd@z Thu Jan 1 00:00:00 1970 From: Andrew Cooper Subject: Re: [PATCH 0/3] docs: User oriented documentation Date: Wed, 20 Mar 2019 16:47:43 +0000 Message-ID: <3a8c7455-e8e8-fb1e-1207-371ea86e1e31@citrix.com> References: <1553012407-19885-1-git-send-email-andrew.cooper3@citrix.com> <20190320112036.GP14641@zion.uk.xensource.com> <7bd031df-b291-e9f9-3566-4fb02844eb06@citrix.com> <20190320112835.GQ14641@zion.uk.xensource.com> <1eeac531-5d94-a55f-1d53-a13faa4f902e@citrix.com> <23698.10415.31507.47727@mariner.uk.xensource.com> <7863e7f2-bcb4-d46b-1188-9a6941fdb135@citrix.com> <23698.28059.770728.572200@mariner.uk.xensource.com> Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="===============3654251376730275443==" Return-path: In-Reply-To: <23698.28059.770728.572200@mariner.uk.xensource.com> Content-Language: en-GB List-Unsubscribe: , List-Post: List-Help: List-Subscribe: , Errors-To: xen-devel-bounces@lists.xenproject.org Sender: "Xen-devel" To: Ian Jackson Cc: Lars Kurth , Stefano Stabellini , Wei Liu , Konrad Rzeszutek Wilk , George Dunlap , Xen-devel , Julien Grall , Jan Beulich , Roger Pau Monne List-Id: xen-devel@lists.xenproject.org --===============3654251376730275443== Content-Type: multipart/alternative; boundary="------------871BEFAD1BC217DC2C581DD8" Content-Language: en-GB --------------871BEFAD1BC217DC2C581DD8 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: 7bit On 20/03/2019 16:43, Ian Jackson wrote: > Andrew Cooper writes ("Re: [PATCH 0/3] docs: User oriented documentation"): >> It turns out that I mis-interpreted the compatibility note in >> https://www.kernel.org/doc/html/latest/doc-guide/sphinx.html# and >> stretch is probably fine. > OK, good. > > Well, I think we could say that to build this documentation you have > to have the relevant tools. sphinx is certainly well-regarded and > this is probably a worthwhile upgrade. > > What do the earlier tools do ? Should we print some warning and > disable the build, or will they generate slightly-mangled output, or > what ? conf.py has version check in it. On Jessie with native packages, the result is: andrewcoop@andrewcoop:/local/xen.git/xen$ make -C ../docs/ sphinx-html make: Entering directory '/local/xen.git/docs' sphinx-build -b html . sphinx/html Running Sphinx v1.2.3 Sphinx version error: This project needs at least Sphinx v1.4 and therefore cannot be built with this version. Makefile:55: recipe for target 'sphinx-html' failed make: *** [sphinx-html] Error 1 make: Leaving directory '/local/xen.git/docs' ~Andrew --------------871BEFAD1BC217DC2C581DD8 Content-Type: text/html; charset="utf-8" Content-Transfer-Encoding: 7bit
On 20/03/2019 16:43, Ian Jackson wrote:
Andrew Cooper writes ("Re: [PATCH 0/3] docs: User oriented documentation"):

It turns out that I mis-interpreted the compatibility note in
https://www.kernel.org/doc/html/latest/doc-guide/sphinx.html# and
stretch is probably fine.

OK, good.

Well, I think we could say that to build this documentation you have
to have the relevant tools.  sphinx is certainly well-regarded and
this is probably a worthwhile upgrade.

What do the earlier tools do ?  Should we print some warning and
disable the build, or will they generate slightly-mangled output, or
what ?

conf.py has version check in it.

On Jessie with native packages, the result is:

andrewcoop@andrewcoop:/local/xen.git/xen$ make -C ../docs/ sphinx-html
make: Entering directory '/local/xen.git/docs'
sphinx-build -b html . sphinx/html
Running Sphinx v1.2.3

Sphinx version error:
This project needs at least Sphinx v1.4 and therefore cannot be built with this version.
Makefile:55: recipe for target 'sphinx-html' failed
make: *** [sphinx-html] Error 1
make: Leaving directory '/local/xen.git/docs'
~Andrew
--------------871BEFAD1BC217DC2C581DD8-- --===============3654251376730275443== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: base64 Content-Disposition: inline X19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX18KWGVuLWRldmVs IG1haWxpbmcgbGlzdApYZW4tZGV2ZWxAbGlzdHMueGVucHJvamVjdC5vcmcKaHR0cHM6Ly9saXN0 cy54ZW5wcm9qZWN0Lm9yZy9tYWlsbWFuL2xpc3RpbmZvL3hlbi1kZXZlbA== --===============3654251376730275443==--