[libvirt] [PATCH 0/6] docs: some refactoring and new docs about RPM deployment

Mon Nov 11 14:28:28 UTC 2019

On Fri, Nov 08, 2019 at 11:21:06AM +0000, Daniel P. Berrangé wrote:
>This refactors existing docs related to the remote driver/daemon and
>URIs. It then also adds a kbase page about RPM package options.
>
>This introduces the use of RST for docs as a replacement for HTML.
>The intent is that all new docs should use RST from this point.
>
>Existing HTML docs are candidates for conversion to RST by anyone
>interested.
>

Unlike the Perl -> Python conversion, where we already had a mixture of
both, this actually fulfills the prophecy of XKCD #927 [0]

It would be nice if the first usage of RST actually converted existing
HTML docs, to lead by example, but mostly to demonstrate that it is
reasonably capable of replacing XSLT.

Jano

[0] https://xkcd.com/927/

>Daniel P. Berrangé (6):
>  docs: split TLS certificate setup into its own file
>  docs: move docs about remote driver URIs into URI docs
>  build: introduce rst2html as a mandatory build tool
>  docs: adapt filling of <head> section for rst2html output
>  docs: add a kbase page about RPM packaging options
>  docs: add page describing the libvirt daemons
>
> .gitignore                    |   1 +
> docs/Makefile.am              |  21 +-
> docs/daemons.rst              | 209 +++++++++++
> docs/docs.html.in             |   6 +
> docs/kbase.html.in            |   4 +
> docs/kbase/rpm-deployment.rst | 410 ++++++++++++++++++++
> docs/page.xsl                 |   4 +-
> docs/remote.html.in           | 684 +---------------------------------
> docs/tlscerts.html.in         | 413 ++++++++++++++++++++
> docs/uri.html.in              | 263 +++++++++++--
> libvirt.spec.in               |   2 +
> m4/virt-external-programs.m4  |   5 +
> mingw-libvirt.spec.in         |   1 +
> 13 files changed, 1309 insertions(+), 714 deletions(-)
> create mode 100644 docs/daemons.rst
> create mode 100644 docs/kbase/rpm-deployment.rst
> create mode 100644 docs/tlscerts.html.in
>
>-- 
>2.23.0
>
>--
>libvir-list mailing list
>libvir-list at redhat.com
>https://www.redhat.com/mailman/listinfo/libvir-list
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 488 bytes
Desc: not available
URL: <http://listman.redhat.com/archives/libvir-list/attachments/20191111/d9e1e07c/attachment-0001.sig>