From: Tom Rini <trini@konsulko.com>
To: u-boot@lists.denx.de
Subject: [PATCH 1/1] doc: update Kernel documentation build system
Date: Sun, 24 Jan 2021 18:59:32 -0500 [thread overview]
Message-ID: <20210124235932.GA7530@bill-the-cat> (raw)
In-Reply-To: <e72caa5d-e380-ef1b-29e3-88fd3de1f287@gmx.de>
On Sun, Jan 24, 2021 at 10:05:27PM +0100, Heinrich Schuchardt wrote:
> On 1/23/21 6:53 PM, Tom Rini wrote:
> > On Sat, Jan 23, 2021 at 12:46:23PM -0500, Tom Rini wrote:
> > > On Fri, Jan 01, 2021 at 01:21:11AM +0100, Heinrich Schuchardt wrote:
> > >
> > > > Update the docomentation build system according to Linux v5.11-rc1.
> > > >
> > > > With this patch we can build the HTML documentation using either of
> > > > Sphinx 2 and Sphinx 3.
> > > >
> > > > Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
> > > > Reviewed-by: Simon Glass <sjg@chromium.org>
> > >
> > > Applied to u-boot/master, thanks!
> >
> > I've had to revert this. While I caught and fixed up in a semi-logical
> > way one duplicate label problem, there's another now that I see, and
> > probably many more once I rework that one. It's unclear as well how
> > best to handle these otherwise logical duplicate labels, such as "eMMC"
> > in doc/board/microchip/mpfs_icicle.rst for example.
>
> Sphinx 2 is not available for current Linux distributions. Without this
> patch we cannot build with Sphinx 3.
We need to be careful when saying "current". Ubuntu 18.04 is still
quite current enough and will be until 2022 (as it doesn't go EOL until
2023). I'm not sure I can even get Sphinx 3.
> All pages must be deduplicated. Instead of duplicate information
> references have to be used.
So long as it can be done in a way where documentation reads well still,
yes. For example, how should we re-write the example I mentioned so
that "eMMC" isn't duplicated?
> Once that is done and the patch is reapplied we must make sure that on
> gitlab we use Sphinx 3 by moving to a current Ubuntu version.
We'll have to figure out what to do about updating CI, but I'm not sure
moving the host version is a good idea at this time.
--
Tom
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 659 bytes
Desc: not available
URL: <https://lists.denx.de/pipermail/u-boot/attachments/20210124/7f6077c2/attachment.sig>
next prev parent reply other threads:[~2021-01-24 23:59 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-01-01 0:21 [PATCH 1/1] doc: update Kernel documentation build system Heinrich Schuchardt
2021-01-07 12:35 ` Simon Glass
2021-01-23 17:46 ` Tom Rini
2021-01-23 17:53 ` Tom Rini
2021-01-24 21:05 ` Heinrich Schuchardt
2021-01-24 23:59 ` Tom Rini [this message]
2021-01-25 0:41 ` Heinrich Schuchardt
2021-01-25 0:49 ` Sean Anderson
2021-01-25 1:37 ` Tom Rini
2021-01-25 1:56 ` Simon Glass
2021-01-26 15:28 ` Heinrich Schuchardt
2021-01-26 16:02 ` Tom Rini
2021-02-01 20:38 ` Simon Glass
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=20210124235932.GA7530@bill-the-cat \
--to=trini@konsulko.com \
--cc=u-boot@lists.denx.de \
/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