All of lore.kernel.org
 help / color / mirror / Atom feed
From: Peter Maydell <peter.maydell@linaro.org>
To: Stefan Hajnoczi <stefanha@redhat.com>
Cc: Daniel Berrange <berrange@redhat.com>,
	QEMU Developers <qemu-devel@nongnu.org>
Subject: Re: [PATCH 3/3] docs: install CSS and Javascript files for HTML docs
Date: Fri, 8 Nov 2019 10:56:15 +0000	[thread overview]
Message-ID: <CAFEAcA8GS52-a9_LxhOD4xM5dqX++=T8-BNVvjD0hrFTUhm-MQ@mail.gmail.com> (raw)
In-Reply-To: <20191108095942.401225-4-stefanha@redhat.com>

On Fri, 8 Nov 2019 at 10:00, Stefan Hajnoczi <stefanha@redhat.com> wrote:
>
> Install the sphinx CSS/Javascript support files needed by the HTML
> documentation.  The documentation looks ugly without this.
>
> The previous patch switched to only invoking sphinx once so there is
> only one _static/ directory that needs to be installed across all manual
> sections.
>
> Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
> ---
>  Makefile | 1 +
>  1 file changed, 1 insertion(+)
>
> diff --git a/Makefile b/Makefile
> index 9487a06bed..dd60787d4c 100644
> --- a/Makefile
> +++ b/Makefile
> @@ -813,6 +813,7 @@ endef
>  # for QEMU developers, and not interesting to our users.
>  .PHONY: install-sphinxdocs
>  install-sphinxdocs: sphinxdocs
> +       $(call install-manual,_static)
>         $(call install-manual,interop)
>         $(call install-manual,specs)
>         $(INSTALL_DATA) "$(MANUAL_BUILDDIR)/index.html" "$(DESTDIR)$(qemu_docdir)/index.html"

'install-manual' does some complicated stuff to
(a) handle subdirectories and (b) skip things we don't
want to install. It's intended for installing manual
directories (specs, interop, etc). _static is just
a simple single directory with no underlying files,
and it's not a manual, so it seems a bit odd to use
install-manual for it.

Also, this is only needed because we're now building
the docs in a single run (with the 'build manuals
one at a time' approach you get a separate specs/_static,
interop/_static, etc, which are installed by the
relevant install-manual calls for each manual). So
it seems like it ought to be squashed into the commit
that switches to doing the docs build in one run of
sphinx.

thanks
-- PMM


      parent reply	other threads:[~2019-11-08 10:59 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-11-08  9:59 [PATCH 0/3] docs: build an index page for the HTML docs Stefan Hajnoczi
2019-11-08  9:59 ` [PATCH 1/3] docs: fix rst syntax errors in unbuilt docs Stefan Hajnoczi
2019-11-08 10:17   ` Daniel P. Berrangé
2019-11-08  9:59 ` [PATCH 2/3] docs: build a global index page Stefan Hajnoczi
2019-11-08 10:19   ` Daniel P. Berrangé
2019-11-08 10:51   ` Peter Maydell
2019-11-08 11:39     ` Stefan Hajnoczi
2019-11-08 11:56       ` Peter Maydell
2019-11-15 14:23       ` Peter Maydell
2019-11-08  9:59 ` [PATCH 3/3] docs: install CSS and Javascript files for HTML docs Stefan Hajnoczi
2019-11-08 10:19   ` Daniel P. Berrangé
2019-11-08 10:56   ` Peter Maydell [this message]

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='CAFEAcA8GS52-a9_LxhOD4xM5dqX++=T8-BNVvjD0hrFTUhm-MQ@mail.gmail.com' \
    --to=peter.maydell@linaro.org \
    --cc=berrange@redhat.com \
    --cc=qemu-devel@nongnu.org \
    --cc=stefanha@redhat.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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.