[PATCH 00/32] docs: convert formatdomain.html.in to rst and split it up

Peter Krempa posted 32 patches 2 weeks ago
Failed in applying to current master (apply log)
docs/formatdomain-devices-address.rst    |   92 +
docs/formatdomain-devices-chardev.rst    |  682 ++
docs/formatdomain-devices-controller.rst |  305 +
docs/formatdomain-devices-disk.rst       |  821 ++
docs/formatdomain-devices-filesystem.rst |  169 +
docs/formatdomain-devices-graphics.rst   |  244 +
docs/formatdomain-devices-hostdev.rst    |  337 +
docs/formatdomain-devices-hub.rst        |   23 +
docs/formatdomain-devices-input.rst      |   46 +
docs/formatdomain-devices-interface.rst  | 1258 +++
docs/formatdomain-devices-iommu.rst      |   54 +
docs/formatdomain-devices-lease.rst      |   35 +
docs/formatdomain-devices-memballoon.rst |   69 +
docs/formatdomain-devices-memory.rst     |  151 +
docs/formatdomain-devices-nvram.rst      |   26 +
docs/formatdomain-devices-panic.rst      |   44 +
docs/formatdomain-devices-redirdev.rst   |   50 +
docs/formatdomain-devices-rng.rst        |   76 +
docs/formatdomain-devices-shmem.rst      |   50 +
docs/formatdomain-devices-smartcard.rst  |   71 +
docs/formatdomain-devices-sound.rst      |   45 +
docs/formatdomain-devices-tpm.rst        |   94 +
docs/formatdomain-devices-video.rst      |  101 +
docs/formatdomain-devices-virtio.rst     |   59 +
docs/formatdomain-devices-vsock.rst      |   22 +
docs/formatdomain-devices-watchdog.rst   |   63 +
docs/formatdomain-devices.rst            |   67 +
docs/formatdomain.html.in                | 9848 ----------------------
docs/formatdomain.rst                    | 2390 ++++++
docs/generic.css                         |    2 +-
docs/meson.build                         |  131 +-
31 files changed, 7527 insertions(+), 9898 deletions(-)
create mode 100644 docs/formatdomain-devices-address.rst
create mode 100644 docs/formatdomain-devices-chardev.rst
create mode 100644 docs/formatdomain-devices-controller.rst
create mode 100644 docs/formatdomain-devices-disk.rst
create mode 100644 docs/formatdomain-devices-filesystem.rst
create mode 100644 docs/formatdomain-devices-graphics.rst
create mode 100644 docs/formatdomain-devices-hostdev.rst
create mode 100644 docs/formatdomain-devices-hub.rst
create mode 100644 docs/formatdomain-devices-input.rst
create mode 100644 docs/formatdomain-devices-interface.rst
create mode 100644 docs/formatdomain-devices-iommu.rst
create mode 100644 docs/formatdomain-devices-lease.rst
create mode 100644 docs/formatdomain-devices-memballoon.rst
create mode 100644 docs/formatdomain-devices-memory.rst
create mode 100644 docs/formatdomain-devices-nvram.rst
create mode 100644 docs/formatdomain-devices-panic.rst
create mode 100644 docs/formatdomain-devices-redirdev.rst
create mode 100644 docs/formatdomain-devices-rng.rst
create mode 100644 docs/formatdomain-devices-shmem.rst
create mode 100644 docs/formatdomain-devices-smartcard.rst
create mode 100644 docs/formatdomain-devices-sound.rst
create mode 100644 docs/formatdomain-devices-tpm.rst
create mode 100644 docs/formatdomain-devices-video.rst
create mode 100644 docs/formatdomain-devices-virtio.rst
create mode 100644 docs/formatdomain-devices-vsock.rst
create mode 100644 docs/formatdomain-devices-watchdog.rst
create mode 100644 docs/formatdomain-devices.rst
delete mode 100644 docs/formatdomain.html.in
create mode 100644 docs/formatdomain.rst

[PATCH 00/32] docs: convert formatdomain.html.in to rst and split it up

Posted by Peter Krempa 2 weeks ago
This is full version of:

https://www.redhat.com/archives/libvir-list/2020-July/msg00717.html

where I've split out all the subelements into individual files.

This version is also based on top of Pavel's rewrite to the meson build
system to minimize his conflicts and also it was simpler to achieve what
I wanted.

You can fetch this from my repo including Pavel's patches.

git fetch https://gitlab.com/pipo.sk/libvirt.git formatdomain-rst-meson

Unfortunately the pipeline jobs for libvirt are broken on some targets
for non-obvious reasons and for some weird reason the 'website' job is
in the 3rd stage of the pipeline. Thus you don't get to see the final
result until it get's fixed withoug compiling it yourself.

Peter Krempa (32):
  docs: css: Make definition list  'code' entries bold when converted
    from rst
  docs: meson: Simplify generation of html files
  docs: switch building of rst files to a dictionary
  docs: meson: Add dependencies for RST docs
  docs: formatdomain: Convert to rst
  docs: formatdomain: Split out <devices>
  docs: formatdomain-devices: Split out <disk>
  docs: formatdomain-devices: Split out <filesystem>
  docs: formatdomain-devices: Split out address information
  docs: formatdomain-devices: Split out virtio information
  docs: formatdomain-devices: Split out <controller>
  docs: formatdomain-devices: Split out <lease>
  docs: formatdomain-devices: Split out <hostdev>
  docs: formatdomain-devices: Split out <redirdev>
  docs: formatdomain-devices: Split out <smartcard>
  docs: formatdomain-devices: Split out <interface>
  docs: formatdomain-devices: Split out <input>
  docs: formatdomain-devices: Split out <hub>
  docs: formatdomain-devices: Split out <graphics>
  docs: formatdomain-devices: Split out <videO>
  docs: formatdomain-devices: Split out chardevs
  docs: formatdomain-devices: Split out <sound>
  docs: formatdomain-devices: Split out <watchdog>
  docs: formatdomain-devices: Split out <memballoon>
  docs: formatdomain-devices: Split out <rng>
  docs: formatdomain-devices: Split out <tpm>
  docs: formatdomain-devices: Split out <nvram>
  docs: formatdomain-devices: Split out <panic>
  docs: formatdomain-devices: Split out <shmem>
  docs: formatdomain-devices: Split out <memory>
  docs: formatdomain-devices: Split out <iommu>
  docs: formatdomain-devices: Split out <vsock>

 docs/formatdomain-devices-address.rst    |   92 +
 docs/formatdomain-devices-chardev.rst    |  682 ++
 docs/formatdomain-devices-controller.rst |  305 +
 docs/formatdomain-devices-disk.rst       |  821 ++
 docs/formatdomain-devices-filesystem.rst |  169 +
 docs/formatdomain-devices-graphics.rst   |  244 +
 docs/formatdomain-devices-hostdev.rst    |  337 +
 docs/formatdomain-devices-hub.rst        |   23 +
 docs/formatdomain-devices-input.rst      |   46 +
 docs/formatdomain-devices-interface.rst  | 1258 +++
 docs/formatdomain-devices-iommu.rst      |   54 +
 docs/formatdomain-devices-lease.rst      |   35 +
 docs/formatdomain-devices-memballoon.rst |   69 +
 docs/formatdomain-devices-memory.rst     |  151 +
 docs/formatdomain-devices-nvram.rst      |   26 +
 docs/formatdomain-devices-panic.rst      |   44 +
 docs/formatdomain-devices-redirdev.rst   |   50 +
 docs/formatdomain-devices-rng.rst        |   76 +
 docs/formatdomain-devices-shmem.rst      |   50 +
 docs/formatdomain-devices-smartcard.rst  |   71 +
 docs/formatdomain-devices-sound.rst      |   45 +
 docs/formatdomain-devices-tpm.rst        |   94 +
 docs/formatdomain-devices-video.rst      |  101 +
 docs/formatdomain-devices-virtio.rst     |   59 +
 docs/formatdomain-devices-vsock.rst      |   22 +
 docs/formatdomain-devices-watchdog.rst   |   63 +
 docs/formatdomain-devices.rst            |   67 +
 docs/formatdomain.html.in                | 9848 ----------------------
 docs/formatdomain.rst                    | 2390 ++++++
 docs/generic.css                         |    2 +-
 docs/meson.build                         |  131 +-
 31 files changed, 7527 insertions(+), 9898 deletions(-)
 create mode 100644 docs/formatdomain-devices-address.rst
 create mode 100644 docs/formatdomain-devices-chardev.rst
 create mode 100644 docs/formatdomain-devices-controller.rst
 create mode 100644 docs/formatdomain-devices-disk.rst
 create mode 100644 docs/formatdomain-devices-filesystem.rst
 create mode 100644 docs/formatdomain-devices-graphics.rst
 create mode 100644 docs/formatdomain-devices-hostdev.rst
 create mode 100644 docs/formatdomain-devices-hub.rst
 create mode 100644 docs/formatdomain-devices-input.rst
 create mode 100644 docs/formatdomain-devices-interface.rst
 create mode 100644 docs/formatdomain-devices-iommu.rst
 create mode 100644 docs/formatdomain-devices-lease.rst
 create mode 100644 docs/formatdomain-devices-memballoon.rst
 create mode 100644 docs/formatdomain-devices-memory.rst
 create mode 100644 docs/formatdomain-devices-nvram.rst
 create mode 100644 docs/formatdomain-devices-panic.rst
 create mode 100644 docs/formatdomain-devices-redirdev.rst
 create mode 100644 docs/formatdomain-devices-rng.rst
 create mode 100644 docs/formatdomain-devices-shmem.rst
 create mode 100644 docs/formatdomain-devices-smartcard.rst
 create mode 100644 docs/formatdomain-devices-sound.rst
 create mode 100644 docs/formatdomain-devices-tpm.rst
 create mode 100644 docs/formatdomain-devices-video.rst
 create mode 100644 docs/formatdomain-devices-virtio.rst
 create mode 100644 docs/formatdomain-devices-vsock.rst
 create mode 100644 docs/formatdomain-devices-watchdog.rst
 create mode 100644 docs/formatdomain-devices.rst
 delete mode 100644 docs/formatdomain.html.in
 create mode 100644 docs/formatdomain.rst

-- 
2.26.2

Re: [PATCH 00/32] docs: convert formatdomain.html.in to rst and split it up

Posted by Peter Krempa 1 week ago
On Thu, Jul 23, 2020 at 15:21:05 +0200, Peter Krempa wrote:
> This is full version of:
> 
> https://www.redhat.com/archives/libvir-list/2020-July/msg00717.html
> 
> where I've split out all the subelements into individual files.
> 
> This version is also based on top of Pavel's rewrite to the meson build
> system to minimize his conflicts and also it was simpler to achieve what
> I wanted.
> 
> You can fetch this from my repo including Pavel's patches.
> 
> git fetch https://gitlab.com/pipo.sk/libvirt.git formatdomain-rst-meson
> 
> Unfortunately the pipeline jobs for libvirt are broken on some targets
> for non-obvious reasons and for some weird reason the 'website' job is
> in the 3rd stage of the pipeline. Thus you don't get to see the final
> result until it get's fixed withoug compiling it yourself.

The pipeline works now (#magic). You can browse the latest version at:

https://pipo.sk.gitlab.io/-/libvirt/-/jobs/657834768/artifacts/website/formatdomain.html