From: "Daniel P. Berrangé" <berrange@redhat.com>
To: Paolo Bonzini <pbonzini@redhat.com>
Cc: John Snow <jsnow@redhat.com>, qemu-devel <qemu-devel@nongnu.org>,
Peter Maydell <peter.maydell@linaro.org>,
Markus Armbruster <armbru@redhat.com>
Subject: Re: Minimum sphinx version?
Date: Tue, 1 Oct 2024 09:48:40 +0100 [thread overview]
Message-ID: <Zvu3aIWyKEtUfHwN@redhat.com> (raw)
In-Reply-To: <959ad3a2-505b-4d43-878f-027e359e8d54@redhat.com>
On Tue, Oct 01, 2024 at 10:28:50AM +0200, Paolo Bonzini wrote:
> On 9/30/24 19:16, John Snow wrote:
> > The current reality is that Sphinx 3.4.3 is our minimum because RHEL 9
> > offers that as the distro package and I have not dared bump our version
> > beyond that for fear of disrupting our ability to build docs on RHEL 9
> > without internet.
> >
> > What I'd like to ask is: How adamant are we that we can build docs on
> > older platforms? Do we consider it part of our platform promise? Can we
> > bump Sphinx to a slightly newer version at the expense of offline doc
> > builds for RHEL 9?
>
> Could we stop building QMP docs, if Sphinx is too old? While at the same
> time keeping the same 3.x version and the ability to build man pages, which
> is the really important part.
I'm curious how much of SPhinx we actually leverage when generatnug
man pages ? Our content is primarily RST format. Would it be feasible
to just use rst2man for man pages, and just use sphinx for the HTML
docs ?
As I said in my other email though, IMHO, if the distro sphinx is too
old we should just auto-install the newer version that we need, as we
have set a precedent with meson. That way there's no need to disable
docs building
With regards,
Daniel
--
|: https://berrange.com -o- https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org -o- https://fstop138.berrange.com :|
|: https://entangle-photo.org -o- https://www.instagram.com/dberrange :|
next prev parent reply other threads:[~2024-10-01 14:08 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-09-30 17:16 Minimum sphinx version? John Snow
2024-10-01 6:30 ` Markus Armbruster
2024-10-01 8:28 ` Paolo Bonzini
2024-10-01 8:48 ` Daniel P. Berrangé [this message]
2024-10-01 8:38 ` Daniel P. Berrangé
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=Zvu3aIWyKEtUfHwN@redhat.com \
--to=berrange@redhat.com \
--cc=armbru@redhat.com \
--cc=jsnow@redhat.com \
--cc=pbonzini@redhat.com \
--cc=peter.maydell@linaro.org \
--cc=qemu-devel@nongnu.org \
/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).