[PATCH 0/9] Improve docs web reference checker

Tue Feb 14 21:51:08 UTC 2023

Improve the checker tool to also track orphaned pages and check presence
and usage of images. In addition to that this series fixes handful of
instances of the problems that the script caught.

This series adds two documents:

 - docs/logos/README.rst (converted into docs/logos/index.html)

    The page shows all logos which libvirt has. It's now linked from the
    docs page.

   https://pipo.sk.gitlab.io/-/libvirt/-/jobs/3770134533/artifacts/website/logos/index.html

 - docs/golang.rst

    The page ties together the 4 go module pages we have which were not
    linked and is linked from docs.html

   https://pipo.sk.gitlab.io/-/libvirt/-/jobs/3770134533/artifacts/website/golang.html

Peter Krempa (9):
  docs: XSL: Add source document name as custom data attribute for
    <html>
  scripts: check-html-references: Rename --prefix to --webroot and make
    it mandatory
  scripts: check-html-references: Improve error messages and don't mess
    with relative paths
  docs: manpages: Add missing manpages to index
  docs: Add sub-page for all golang modules
  scripts: check-html-references: Detect pages that are not linked to
  kbase: eventloop: Fix path to referenced images
  docs: logos: Turn 'README' into rST, generate an index and link to
    images
  scripts: check-html-refernces: Add checking for image file usage

 docs/docs.rst                      |   5 +-
 docs/golang.rst                    |  21 +++
 docs/kbase/internals/eventloop.rst |   4 +-
 docs/logos/README                  |  98 --------------
 docs/logos/README.rst              | 166 ++++++++++++++++++++++++
 docs/logos/meson.build             |  47 +++++++
 docs/manpages/index.rst            |   3 +
 docs/meson.build                   |   3 +-
 docs/page.xsl                      |   2 +-
 scripts/check-html-references.py   | 198 +++++++++++++++++++++++------
 10 files changed, 406 insertions(+), 141 deletions(-)
 create mode 100644 docs/golang.rst
 delete mode 100644 docs/logos/README
 create mode 100644 docs/logos/README.rst

-- 
2.39.1