| Message ID | 20191108095942.401225-4-stefanha@redhat.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | docs: build an index page for the HTML docs | expand |
On Fri, Nov 08, 2019 at 10:59:42AM +0100, Stefan Hajnoczi 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(+) Reviewed-by: Daniel P. Berrangé <berrange@redhat.com> Regards, Daniel
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
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 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(+)