From: "Martin Liška" <mliska@suse.cz>
To: Jakub Jelinek <jakub@redhat.com>, Joseph Myers <joseph@codesourcery.com>
Cc: Xi Ruoyao <xry111@linuxfromscratch.org>,
Sandra Loosemore <sandra@codesourcery.com>,
GCC Patches <gcc-patches@gcc.gnu.org>,
GCC Development <gcc@gcc.gnu.org>
Subject: Announcement: Porting the Docs to Sphinx - tomorrow
Date: Tue, 8 Nov 2022 14:55:49 +0100 [thread overview]
Message-ID: <2ab60531-23fd-9a27-c84c-4948b79bc84a@suse.cz> (raw)
In-Reply-To: <Y1F7m7fTAnLScqxs@tucnak>
Hi.
Tomorrow in the morning (UTC time), I'm going to migrate the documentation
to Sphinx. The final version of the branch can be seen here:
$ git fetch origin refs/users/marxin/heads/sphinx-final
$ git co FETCH_HEAD
URL: https://splichal.eu/gccsphinx-final/
TL;DR;
After the migration, people should be able to build (and install) GCC even
if they miss Sphinx (similar happens now if you miss makeinfo). However, please
install Sphinx >= 5.3.0 (for manual and info pages - only *core* package is necessary) [1]
Steps following the migration:
1) update of web HTML (and PDF documentation) pages:
I prepared a script and tested our server has all what we need.
2) gcc_release --enable-generated-files-in-srcdir: here I would like
to ask Joseph for cooperation
3) URL for diagnostics (used for warning) - will utilize [3]
4) package source tarballs - https://gcc.gnu.org/onlinedocs/ (listed here)
5) updating links from gcc.gnu.org that point to documentation
6) removal of the further Texinfo leftovers
...
Cheers,
Martin
[1] https://splichal.eu/scripts/sphinx/gccint/_build/html/source-tree-structure-and-build-system/the-gcc-subdirectory/building-documentation.html#sphinx-install
[2] ./maintainer-scripts/update_web_docs_git.py
[3] https://pypi.org/project/sphinx-redirect-by-id/
next prev parent reply other threads:[~2022-11-08 13:55 UTC|newest]
Thread overview: 42+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-01-31 14:06 Porting the Docs to Sphinx - project status Martin Liška
2022-02-04 13:40 ` Matthias Klose
2022-03-08 15:59 ` Martin Liška
2022-08-02 12:48 ` Martin Liška
2022-10-17 13:28 ` Announcement: Porting the Docs to Sphinx - 9. November 2022 Martin Liška
2022-10-17 14:16 ` Paul Iannetta
2022-10-19 7:24 ` Martin Liška
2022-10-19 8:13 ` Paul Iannetta
2022-10-19 9:22 ` Martin Liška
2022-10-19 16:42 ` Joseph Myers
2022-10-20 11:13 ` Martin Liška
2022-10-17 22:26 ` Sandra Loosemore
2022-10-19 11:09 ` Martin Liška
2022-10-19 12:45 ` Martin Liška
2022-10-19 16:30 ` Sandra Loosemore
2022-10-20 11:26 ` Martin Liška
2022-10-20 2:26 ` Xi Ruoyao
2022-10-20 11:27 ` Martin Liška
2022-10-20 11:49 ` Xi Ruoyao
2022-10-20 11:53 ` Martin Liška
2022-10-20 11:55 ` Xi Ruoyao
2022-10-20 12:26 ` Martin Liška
2022-10-20 15:35 ` Joseph Myers
2022-10-20 15:50 ` Martin Liška
2022-10-20 16:43 ` Joseph Myers
2022-10-20 16:47 ` Jakub Jelinek
2022-11-08 13:55 ` Martin Liška [this message]
2022-11-08 18:44 ` Announcement: Porting the Docs to Sphinx - tomorrow Sam James
2022-11-09 0:00 ` Joseph Myers
2022-11-09 0:06 ` Sam James
2022-11-09 7:49 ` Richard Biener
2022-11-09 10:18 ` Mark Wielaard
2022-11-09 17:11 ` Joseph Myers
2022-11-09 17:16 ` Richard Biener
2022-11-11 20:52 ` Gerald Pfeifer
2022-11-11 21:10 ` Sandra Loosemore
2022-11-13 15:44 ` Martin Liška
2022-11-09 14:45 ` Announcement: Porting the Docs to Sphinx - 9. November 2022 Martin Liška
2022-11-09 17:14 ` Joseph Myers
2022-11-10 13:05 ` Martin Liška
2022-11-10 13:50 ` Richard Biener
2022-11-11 23:05 ` David Malcolm
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=2ab60531-23fd-9a27-c84c-4948b79bc84a@suse.cz \
--to=mliska@suse.cz \
--cc=gcc-patches@gcc.gnu.org \
--cc=gcc@gcc.gnu.org \
--cc=jakub@redhat.com \
--cc=joseph@codesourcery.com \
--cc=sandra@codesourcery.com \
--cc=xry111@linuxfromscratch.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 read-only IMAP folder(s) and NNTP newsgroup(s).