public inbox for
 help / color / mirror / Atom feed
From: "Martin Liška" <>
To: Andrew Pinski <>, GCC Mailing List <>
Cc: GCC Patches <>
Subject: Revert Sphinx documentation [Was: Issues with Sphinx]
Date: Mon, 14 Nov 2022 03:49:35 +0100	[thread overview]
Message-ID: <> (raw)
In-Reply-To: <>


The situation with the Sphinx migration went out of control. The TODO list
overwhelmed me and there are road-blocks that can't be easily fixed with what
Sphinx currently supports. That would require addition of an upstream support and
a possible new Sphinx release.

Let me summarize the biggest road blocks:

1) PR107634 - documentation is divided among much files than it used to be; plus
   the current filenames tend to be very long
2) Index page regressions: PR107643 and PR107651
3) PR107656 - c::macro and c::function does replace [Macro:], [Target Hook:] well
4), build system issues: missing support for lib*/ and various
   limitation when it comes to 'make install-*'. Moreover, gcc_release --enable-generated-files-in-srcdir
   is not supported yet.

Plus, there are other issues linked in PR107655 and we face the issue that
many web links (to GCC documentation) are in the wild and should not become 404.

I would like to apologize to anybody who wasted a time with adoption to the Sphinx format
which we be reverted eventually. Special thanks belongs to all people who helped me and
prepared various patches.

I'm going to revert the patchset during today (Monday) and I'll send a patch with a couple
of new changes that landed in the period of time we used Sphinx.

Thank you for your understanding.

       reply	other threads:[~2022-11-14  2:49 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <>
2022-11-14  2:49 ` Martin Liška [this message]
2022-11-14  8:38   ` Martin Liška
2022-11-14  9:24     ` Jonathan Wakely
2022-11-14 22:26       ` Gerald Pfeifer
2022-11-14 13:06   ` Gerald Pfeifer
2022-11-15 10:05     ` Martin Liška

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:

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \ \ \ \ \ \

* 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 read-only IMAP folder(s) and NNTP newsgroup(s).