public inbox for gcc-patches@gcc.gnu.org
 help / color / mirror / Atom feed
From: "Martin Liška" <mliska@suse.cz>
To: gcc-patches@gcc.gnu.org
Cc: Jonathan Wakely <jwakely.gcc@gmail.com>
Subject: [PATCH] contrib: use sphinx-build from a venv
Date: Mon, 25 Jul 2022 16:00:02 +0200	[thread overview]
Message-ID: <7e41c1dd-d95a-0769-bfb5-c3713da240ab@suse.cz> (raw)

Hi.

As you likely know, I'm still working on transition of the current docs to Sphinx.
But for now, I've sent a modernizing patches for the current libgccjit documentation
and I will need a more recent version of Sphinx.

Can please a maintainer install the package from pip?

Something like:
virtualenv /home/gcc/venv && /home/gcc/venv/bin/pip install Sphinx

or a similar location?

Thanks,
Martin

maintainer-scripts/ChangeLog:

	* update_web_docs_git: Use sphinx-build from a venv so that
	we can use a recent version.
---
 maintainer-scripts/update_web_docs_git | 21 ++++++---------------
 1 file changed, 6 insertions(+), 15 deletions(-)

diff --git a/maintainer-scripts/update_web_docs_git b/maintainer-scripts/update_web_docs_git
index 996d29bfb68..4b01b3dc1c0 100755
--- a/maintainer-scripts/update_web_docs_git
+++ b/maintainer-scripts/update_web_docs_git
@@ -176,23 +176,14 @@ for file in $MANUALS; do
   fi
 done
 
-# The jit is a special-case, using sphinx rather than texinfo.
-# Specifically, the jit docs need sphinx 1.0 or later.
+# The jit is a special-case, using Sphinx rather than texinfo.
+# Specifically, the jit docs need Sphinx 3.0 or later.
 #
-# The jit/docs Makefile uses the executable $(SPHINXBUILD),
-# defaulting to "sphinx-build".
-#
-# sphinx is packaged in Fedora and EPEL 6 within "python-sphinx",
-# in RHEL 8 within "python3-sphinx",
-# and in openSUSE within "python-Sphinx".
-#
-# For EPEL6, python-sphinx is sphinx 0.6.6, which is missing various
-# directives (e.g. ":c:macro:"), so we need the variant
-# python-sphinx10 package.  The latter installs its executable as
-#   /usr/bin/sphinx-1.0-build
-# so we needed to override SPHINXBUILD with this when invoking "make".
+# Use the Sphinx installed in a virtual environment so that
+# we don't depend on a system package.
+
 pushd gcc/gcc/jit/docs
-make html || true
+make html SPHINXBUILD=/home/gcc/venv/bin/sphinx-build || true
 popd
 cp -a gcc/gcc/jit/docs/_build/html jit
 mkdir -p $DOCSDIR/jit
-- 
2.37.1


             reply	other threads:[~2022-07-25 14:00 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-07-25 14:00 Martin Liška [this message]
2022-07-26  7:26 ` Martin Liška
2022-07-26 11:45   ` Frank Ch. Eigler
2022-07-26 11:54     ` Jonathan Wakely
2022-07-26 11:56       ` Frank Ch. Eigler
2022-07-26 12:01         ` Jonathan Wakely
2022-07-26 12:17           ` 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:
  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=7e41c1dd-d95a-0769-bfb5-c3713da240ab@suse.cz \
    --to=mliska@suse.cz \
    --cc=gcc-patches@gcc.gnu.org \
    --cc=jwakely.gcc@gmail.com \
    /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).