[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [PATCH 2/3] docs: build a global index page
From: |
Daniel P . Berrangé |
Subject: |
Re: [PATCH 2/3] docs: build a global index page |
Date: |
Fri, 8 Nov 2019 10:19:00 +0000 |
User-agent: |
Mutt/1.12.1 (2019-06-15) |
On Fri, Nov 08, 2019 at 10:59:41AM +0100, Stefan Hajnoczi wrote:
> Build docs/ in a single sphinx invocation instead of treating
> docs/{devel,interop,specs} separately. This allows us to build a global
> index page that links to documentation across the different manuals.
>
> Some documentation is built outside of sphinx and is not formatted as
> reStructuredText. Link directly to the .html files for the time being.
> If they are converted to .rst files in the future they can be included
> more elegantly.
>
> Sphinx wants to build all .rst files and complains if they are not
> listed in the table of contents. We have not yet reviewed and
> categorized some of our .rst files. Hide these files so they are always
> built (and syntax-checked from now on!) but not visible in the table of
> contents.
Ah, nice trick.
>
> Signed-off-by: Stefan Hajnoczi <address@hidden>
> ---
> Makefile | 13 ++++---------
> docs/index.rst | 27 ++++++++++++++++++++++++++-
> 2 files changed, 30 insertions(+), 10 deletions(-)
Reviewed-by: Daniel P. Berrangé <address@hidden>
Regards,
Daniel
--
|: https://berrange.com -o- https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org -o- https://fstop138.berrange.com :|
|: https://entangle-photo.org -o- https://www.instagram.com/dberrange :|