[PATCH 0/9] docs: kbase style change and cleanups
Some patches are taken from an older series where we've discussed that the kbase page should look more like 'docs.html' as more articles appear, this series delivers that: https://www.redhat.com/archives/libvir-list/2020-August/msg00172.html ... and a few other changes. Final output: https://pipo.sk.gitlab.io/-/libvirt/-/jobs/830387801/artifacts/website/docs.... Peter Krempa (9): docs: Fix title of 'docs' page docs: xslt: Use 'Link' rather than 'Permalink' in header links docs: css: Add a gray box around table of contents of RST based docs docs: kbase: Move index page to docs/kbase docs: kbase: Remove extra container from index page docs: kbase: Split articles into sections docs: xsl: Unify stylability of main container element docs: css: Modify appearance of the kbase directory page docs: kbase: Reorder some articles in the 'Usage' section docs/docs.html.in | 5 ++-- docs/index.html.in | 4 +-- docs/kbase.rst | 53 --------------------------------- docs/kbase/index.rst | 57 +++++++++++++++++++++++++++++++++++ docs/kbase/meson.build | 1 + docs/libvirt.css | 67 +++++++++++++++++++++++++++--------------- docs/meson.build | 1 - docs/page.xsl | 27 ++++++++++------- scripts/hvsupport.py | 2 +- 9 files changed, 124 insertions(+), 93 deletions(-) delete mode 100644 docs/kbase.rst create mode 100644 docs/kbase/index.rst -- 2.26.2
XSLT transformation generates the page title from the topmost <h1> element which is not present in 'docs.html.in'. Add it and hide it in the CSS. Signed-off-by: Peter Krempa <pkrempa@redhat.com> --- docs/docs.html.in | 1 + docs/libvirt.css | 4 ++++ 2 files changed, 5 insertions(+) diff --git a/docs/docs.html.in b/docs/docs.html.in index 428a2ac974..920a773d79 100644 --- a/docs/docs.html.in +++ b/docs/docs.html.in @@ -2,6 +2,7 @@ <!DOCTYPE html> <html xmlns="http://www.w3.org/1999/xhtml"> <body class="docs"> + <h1>Documentation</h1> <div class="panel"> <h2>Deployment / operation</h2> diff --git a/docs/libvirt.css b/docs/libvirt.css index 4dc9d3ac76..d323b6ec0f 100644 --- a/docs/libvirt.css +++ b/docs/libvirt.css @@ -427,6 +427,10 @@ body.index h1 { height: 300px; } +body.docs h1 { + visibility: hidden; +} + br.clear { clear: both; border: 0px; -- 2.26.2
The anchors are based on the article or chapter headers, thus they are not 100% permanent. Especially with pages generated from RST. Signed-off-by: Peter Krempa <pkrempa@redhat.com> --- docs/page.xsl | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/page.xsl b/docs/page.xsl index 07bfc52a4c..9e0d4e0954 100644 --- a/docs/page.xsl +++ b/docs/page.xsl @@ -194,10 +194,10 @@ <xsl:element name="{name()}"> <xsl:apply-templates mode="copy" /> <xsl:if test="./html:a/@id"> - <a class="headerlink" href="#{html:a/@id}" title="Permalink to this headline">¶</a> + <a class="headerlink" href="#{html:a/@id}" title="Link to this headline">¶</a> </xsl:if> <xsl:if test="parent::html:div[@class='section']"> - <a class="headerlink" href="#{../@id}" title="Permalink to this headline">¶</a> + <a class="headerlink" href="#{../@id}" title="Link to this headline">¶</a> </xsl:if> </xsl:element> </xsl:template> -- 2.26.2
Emphasise the table of contents visually. Signed-off-by: Peter Krempa <pkrempa@redhat.com> --- docs/libvirt.css | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/docs/libvirt.css b/docs/libvirt.css index d323b6ec0f..227b9ebed6 100644 --- a/docs/libvirt.css +++ b/docs/libvirt.css @@ -598,8 +598,13 @@ th p, td p { /* Elements with id 'contents' contain the table of contents generated by docutils */ #contents { - margin-top: 2em; - margin-bottom: 2em; + margin-top: 1em; + margin-bottom: 1em; + background: rgb(230, 230, 230); + padding: 0.5em; + padding-left: 0px; + display: inline-block; + border: 1px solid #999999; } #contents p.topic-title { -- 2.26.2
Move docs/kbase.rst to docs/kbase/index.rst so that the directory itself shows our index page rather than the autogenerated list of files by the webserver. Signed-off-by: Peter Krempa <pkrempa@redhat.com> --- docs/docs.html.in | 2 +- docs/index.html.in | 2 +- docs/{kbase.rst => kbase/index.rst} | 32 ++++++++++++++--------------- docs/kbase/meson.build | 1 + docs/meson.build | 1 - 5 files changed, 19 insertions(+), 19 deletions(-) rename docs/{kbase.rst => kbase/index.rst} (57%) diff --git a/docs/docs.html.in b/docs/docs.html.in index 920a773d79..77d5c78b30 100644 --- a/docs/docs.html.in +++ b/docs/docs.html.in @@ -126,7 +126,7 @@ <dt><a href="hvsupport.html">Driver support</a></dt> <dd>matrix of API support per hypervisor per release</dd> - <dt><a href="kbase.html">Knowledge Base</a></dt> + <dt><a href="kbase/index.html">Knowledge Base</a></dt> <dd>Task oriented guides to key features</dd> </dl> </div> diff --git a/docs/index.html.in b/docs/index.html.in index 97421c5e7b..3057a052dd 100644 --- a/docs/index.html.in +++ b/docs/index.html.in @@ -64,7 +64,7 @@ <dt><a href="https://wiki.libvirt.org">Wiki</a></dt> <dd>Read further community contributed content</dd> - <dt><a href="https://libvirt.org/kbase.html">Knowledge base</a></dt> + <dt><a href="https://libvirt.org/kbase/index.html">Knowledge base</a></dt> <dd>Learn more about libvirt through knowledge base</dd> </dl> </div> diff --git a/docs/kbase.rst b/docs/kbase/index.rst similarity index 57% rename from docs/kbase.rst rename to docs/kbase/index.rst index a6de4b1a1a..cf424bd099 100644 --- a/docs/kbase.rst +++ b/docs/kbase/index.rst @@ -4,50 +4,50 @@ Knowledge base .. container:: panel widepanel - `Debug logs <kbase/debuglogs.html>`__ + `Debug logs <debuglogs.html>`__ Configuration of logging and tips on how to file a good bug report. - `Disk locking <kbase/locking.html>`__ + `Disk locking <locking.html>`__ Ensuring exclusive guest access to disks with - `virtlockd <kbase/locking-lockd.html>`__ or - `Sanlock <kbase/locking-sanlock.html>`__ + `virtlockd <locking-lockd.html>`__ or + `Sanlock <locking-sanlock.html>`__ - `Secure usage <kbase/secureusage.html>`__ + `Secure usage <secureusage.html>`__ Secure usage of the libvirt APIs - `Protected virtualization on s390 <kbase/s390_protected_virt.html>`__ + `Protected virtualization on s390 <s390_protected_virt.html>`__ Running secure s390 guests with IBM Secure Execution - `Launch security <kbase/launch_security_sev.html>`__ + `Launch security <launch_security_sev.html>`__ Securely launching VMs with AMD SEV - `Domain state capture <kbase/domainstatecapture.html>`__ + `Domain state capture <domainstatecapture.html>`__ Comparison between different methods of capturing domain state - `RPM deployment <kbase/rpm-deployment.html>`__ + `RPM deployment <rpm-deployment.html>`__ Explanation of the different RPM packages and illustration of which to pick for installation - `Backing chain management <kbase/backing_chains.html>`__ + `Backing chain management <backing_chains.html>`__ Explanation of how disk backing chain specification impacts libvirt's behaviour and basic troubleshooting steps of disk problems. - `Security with QEMU passthrough <kbase/qemu-passthrough-security.html>`__ + `Security with QEMU passthrough <qemu-passthrough-security.html>`__ Examination of the security protections used for QEMU and how they need configuring to allow use of QEMU passthrough with host files/devices. - `Systemtap <kbase/systemtap.html>`__ + `Systemtap <systemtap.html>`__ Explanation of how to use systemtap for libvirt tracing. - `Virtio-FS <kbase/virtiofs.html>`__ + `Virtio-FS <virtiofs.html>`__ Share a filesystem between the guest and the host - `KVM real time <kbase/kvm-realtime.html>`__ + `KVM real time <kvm-realtime.html>`__ Run real time workloads in guests on a KVM hypervisor - `Incremental backup internals <kbase/incrementalbackupinternals.html>`__ + `Incremental backup internals <incrementalbackupinternals.html>`__ Incremental backup implementation details relevant for users - `VM migration internals <kbase/migrationinternals.html>`__ + `VM migration internals <migrationinternals.html>`__ VM migration implementation details, complementing the info in `migration <migration.html>`__ diff --git a/docs/kbase/meson.build b/docs/kbase/meson.build index c0fa72ff35..7b4e7abbd3 100644 --- a/docs/kbase/meson.build +++ b/docs/kbase/meson.build @@ -3,6 +3,7 @@ docs_kbase_files = [ 'debuglogs', 'domainstatecapture', 'incrementalbackupinternals', + 'index', 'kvm-realtime', 'launch_security_sev', 'locking-lockd', diff --git a/docs/meson.build b/docs/meson.build index a915d6252a..0e96123797 100644 --- a/docs/meson.build +++ b/docs/meson.build @@ -118,7 +118,6 @@ docs_rst_files = [ 'formatdomain', 'glib-adoption', 'hacking', - 'kbase', 'libvirt-go', 'libvirt-go-xml', 'newreposetup', -- 2.26.2
The container was used to apply CSS classes to the content, so the looks are degraded. The idea is to have a similar layout to the 'docs.html' page with multiple columns, which will be added later. Signed-off-by: Peter Krempa <pkrempa@redhat.com> --- docs/kbase/index.rst | 70 +++++++++++++++++++++----------------------- docs/libvirt.css | 8 ----- 2 files changed, 34 insertions(+), 44 deletions(-) diff --git a/docs/kbase/index.rst b/docs/kbase/index.rst index cf424bd099..b3e6e5461b 100644 --- a/docs/kbase/index.rst +++ b/docs/kbase/index.rst @@ -2,52 +2,50 @@ Knowledge base ============== -.. container:: panel widepanel +`Debug logs <debuglogs.html>`__ + Configuration of logging and tips on how to file a good bug report. - `Debug logs <debuglogs.html>`__ - Configuration of logging and tips on how to file a good bug report. +`Disk locking <locking.html>`__ + Ensuring exclusive guest access to disks with + `virtlockd <locking-lockd.html>`__ or + `Sanlock <locking-sanlock.html>`__ - `Disk locking <locking.html>`__ - Ensuring exclusive guest access to disks with - `virtlockd <locking-lockd.html>`__ or - `Sanlock <locking-sanlock.html>`__ +`Secure usage <secureusage.html>`__ + Secure usage of the libvirt APIs - `Secure usage <secureusage.html>`__ - Secure usage of the libvirt APIs +`Protected virtualization on s390 <s390_protected_virt.html>`__ + Running secure s390 guests with IBM Secure Execution - `Protected virtualization on s390 <s390_protected_virt.html>`__ - Running secure s390 guests with IBM Secure Execution +`Launch security <launch_security_sev.html>`__ + Securely launching VMs with AMD SEV - `Launch security <launch_security_sev.html>`__ - Securely launching VMs with AMD SEV +`Domain state capture <domainstatecapture.html>`__ + Comparison between different methods of capturing domain state - `Domain state capture <domainstatecapture.html>`__ - Comparison between different methods of capturing domain state +`RPM deployment <rpm-deployment.html>`__ + Explanation of the different RPM packages and illustration of which to + pick for installation - `RPM deployment <rpm-deployment.html>`__ - Explanation of the different RPM packages and illustration of which to - pick for installation +`Backing chain management <backing_chains.html>`__ + Explanation of how disk backing chain specification impacts libvirt's + behaviour and basic troubleshooting steps of disk problems. - `Backing chain management <backing_chains.html>`__ - Explanation of how disk backing chain specification impacts libvirt's - behaviour and basic troubleshooting steps of disk problems. +`Security with QEMU passthrough <qemu-passthrough-security.html>`__ + Examination of the security protections used for QEMU and how they need + configuring to allow use of QEMU passthrough with host files/devices. - `Security with QEMU passthrough <qemu-passthrough-security.html>`__ - Examination of the security protections used for QEMU and how they need - configuring to allow use of QEMU passthrough with host files/devices. +`Systemtap <systemtap.html>`__ + Explanation of how to use systemtap for libvirt tracing. - `Systemtap <systemtap.html>`__ - Explanation of how to use systemtap for libvirt tracing. +`Virtio-FS <virtiofs.html>`__ + Share a filesystem between the guest and the host - `Virtio-FS <virtiofs.html>`__ - Share a filesystem between the guest and the host +`KVM real time <kvm-realtime.html>`__ + Run real time workloads in guests on a KVM hypervisor - `KVM real time <kvm-realtime.html>`__ - Run real time workloads in guests on a KVM hypervisor +`Incremental backup internals <incrementalbackupinternals.html>`__ + Incremental backup implementation details relevant for users - `Incremental backup internals <incrementalbackupinternals.html>`__ - Incremental backup implementation details relevant for users - - `VM migration internals <migrationinternals.html>`__ - VM migration implementation details, complementing the info in - `migration <migration.html>`__ +`VM migration internals <migrationinternals.html>`__ + VM migration implementation details, complementing the info in + `migration <migration.html>`__ diff --git a/docs/libvirt.css b/docs/libvirt.css index 227b9ebed6..1511ccf9e9 100644 --- a/docs/libvirt.css +++ b/docs/libvirt.css @@ -402,14 +402,6 @@ div.panel { background: rgb(230, 230, 230); } -div.widepanel { - width: 70em; - max-width: 95%; - margin-left: 0px; - float: left; - background: rgb(230, 230, 230); -} - div.panel h2 { margin-top: 0px; padding: 0.5em; -- 2.26.2
Split the existing list of kbase articles into a 'Usage' category and into 'Internals/Debugging'. This will later represent the two columns on the web page. Signed-off-by: Peter Krempa <pkrempa@redhat.com> --- docs/kbase/index.rst | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/docs/kbase/index.rst b/docs/kbase/index.rst index b3e6e5461b..f9e42f211f 100644 --- a/docs/kbase/index.rst +++ b/docs/kbase/index.rst @@ -2,8 +2,8 @@ Knowledge base ============== -`Debug logs <debuglogs.html>`__ - Configuration of logging and tips on how to file a good bug report. +Usage +----- `Disk locking <locking.html>`__ Ensuring exclusive guest access to disks with @@ -34,15 +34,21 @@ Knowledge base Examination of the security protections used for QEMU and how they need configuring to allow use of QEMU passthrough with host files/devices. -`Systemtap <systemtap.html>`__ - Explanation of how to use systemtap for libvirt tracing. - `Virtio-FS <virtiofs.html>`__ Share a filesystem between the guest and the host `KVM real time <kvm-realtime.html>`__ Run real time workloads in guests on a KVM hypervisor +Internals / Debugging +--------------------- + +`Debug logs <debuglogs.html>`__ + Configuration of logging and tips on how to file a good bug report. + +`Systemtap <systemtap.html>`__ + Explanation of how to use systemtap for libvirt tracing. + `Incremental backup internals <incrementalbackupinternals.html>`__ Incremental backup implementation details relevant for users -- 2.26.2
page.xsl was adding '<div id="content">' wrapper for the content picked up from the <body> element from the original input file. Optionally class="$DOCNAME" was added for some documents taken from <body>. Since docs generated from RST by docutils have a '<div class='document' id='$DOCNAME>' we actually don't need an extra wrapper for them. Additionally if we standardize on one of them we can use the same styles for both. I've picked the latter because it makes more sense to use the document name as 'id'. This patch: 1) Modifies the XSL trasformation to add the wrapper only if it's not present. 2) Modifies the XSL transformation to use 'id' for document name and class='document' for the wrapper element. 3) Changes docs.html/index.html/hvsupport.html to use 'id' instead of 'class' for document name. 4) Modifies the main stylesheet to keep styling the elements properly Signed-off-by: Peter Krempa <pkrempa@redhat.com> --- docs/docs.html.in | 2 +- docs/index.html.in | 2 +- docs/libvirt.css | 12 ++++++------ docs/page.xsl | 23 +++++++++++++++-------- scripts/hvsupport.py | 2 +- 5 files changed, 24 insertions(+), 17 deletions(-) diff --git a/docs/docs.html.in b/docs/docs.html.in index 77d5c78b30..22a43517ed 100644 --- a/docs/docs.html.in +++ b/docs/docs.html.in @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html> <html xmlns="http://www.w3.org/1999/xhtml"> - <body class="docs"> + <body id="docs"> <h1>Documentation</h1> <div class="panel"> <h2>Deployment / operation</h2> diff --git a/docs/index.html.in b/docs/index.html.in index 3057a052dd..df182c27b6 100644 --- a/docs/index.html.in +++ b/docs/index.html.in @@ -8,7 +8,7 @@ // --> </script> </head> - <body class="index"> + <body id="index"> <h1>The virtualization API</h1> <div class="panel"> diff --git a/docs/libvirt.css b/docs/libvirt.css index 1511ccf9e9..bb71244a7e 100644 --- a/docs/libvirt.css +++ b/docs/libvirt.css @@ -95,7 +95,7 @@ margin-right: 1em; } -#content { +.document { margin-left: auto; margin-right: auto; padding: 0px; @@ -104,9 +104,9 @@ width: 70em; } -body.index #content, -body.docs #content, -body.hvsupport #content +#index.document, +#docs.document, +#hvsupport.document { width: inherit; } @@ -412,14 +412,14 @@ div.panel h2 { text-align: center; } -body.index h1 { +#index.document h1 { border: 0px; text-indent: 100%; white-space: nowrap; overflow: hidden; background: url(logos/logo-banner-dark-800.png) no-repeat center center; height: 300px; } -body.docs h1 { +#docs.document h1 { visibility: hidden; } diff --git a/docs/page.xsl b/docs/page.xsl index 9e0d4e0954..5cb4322fdc 100644 --- a/docs/page.xsl +++ b/docs/page.xsl @@ -112,15 +112,22 @@ </script> </head> <body onload="pageload()"> - <xsl:if test="html:html/html:body/@class"> - <xsl:attribute name="class"> - <xsl:value-of select="html:html/html:body/@class"/> - </xsl:attribute> - </xsl:if> <div id="body"> - <div id="content"> - <xsl:apply-templates select="/html:html/html:body/*" mode="content"/> - </div> + <xsl:choose> + <xsl:when test="html:html/html:body/html:div/@class='document'"> + <xsl:apply-templates select="/html:html/html:body/*" mode="content"/> + </xsl:when> + <xsl:otherwise> + <div class="document"> + <xsl:if test="html:html/html:body/@id"> + <xsl:attribute name="id"> + <xsl:value-of select="html:html/html:body/@id"/> + </xsl:attribute> + </xsl:if> + <xsl:apply-templates select="/html:html/html:body/*" mode="content"/> + </div> + </xsl:otherwise> + </xsl:choose> </div> <div id="nav"> <div id="home"> diff --git a/scripts/hvsupport.py b/scripts/hvsupport.py index e2aab8feff..50ba25c78f 100755 --- a/scripts/hvsupport.py +++ b/scripts/hvsupport.py @@ -420,7 +420,7 @@ for drv in drivers.keys(): print('''<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html> <html xmlns="http://www.w3.org/1999/xhtml"> -<body class="hvsupport"> +<body id="hvsupport"> <h1>libvirt API support matrix</h1> <ul id="toc"></ul> -- 2.26.2
Re-style the knowledge base to look like the 'docs.html' page. We still have room to add one more column. Signed-off-by: Peter Krempa <pkrempa@redhat.com> --- docs/libvirt.css | 38 ++++++++++++++++++++++++++++---------- 1 file changed, 28 insertions(+), 10 deletions(-) diff --git a/docs/libvirt.css b/docs/libvirt.css index bb71244a7e..5195588a8f 100644 --- a/docs/libvirt.css +++ b/docs/libvirt.css @@ -106,7 +106,8 @@ #index.document, #docs.document, -#hvsupport.document +#hvsupport.document, +#knowledge-base.document { width: inherit; } @@ -395,14 +396,17 @@ h6:hover > a.headerlink { visibility: visible; } -div.panel { +div.panel, +#knowledge-base .section +{ width: 24%; margin-left: 7%; float: left; background: rgb(230, 230, 230); } -div.panel h2 { +div.panel h2, +#knowledge-base .section h1 { margin-top: 0px; padding: 0.5em; padding-left: 1em; @@ -419,6 +423,11 @@ div.panel h2 { height: 300px; } +#knowledge-base.document > h1 { + text-align: center; + padding: 1em; +} + #docs.document h1 { visibility: hidden; } @@ -475,29 +484,38 @@ br.clear { font-size: smaller; } -div.panel dd { +div.panel dd, +#knowledge-base dd { font-size: smaller; } -div.panel a { +div.panel a, +#knowledge-base a { text-decoration: none; } div.panel ul, div.panel p, -div.panel dl { +div.panel dl, +#knowledge-base ul, +#knowledge-base p, +#knowledge-base dl { padding: 0.5em; margin: 0px; } - -div.panel ul { +div.panel ul, +#knowledge-base ul { margin-left: 1em; } -div.panel dt { + +div.panel dt, +#knowledge-base dt { margin: 0px; } -div.panel dd { + +div.panel dd, +#knowledge-base dd { margin: 0px; margin-bottom: 1em; } -- 2.26.2
Historically we've added them in chronological order, but certain articles are more likely to be needed and thus are easier to find when placed earlier. Signed-off-by: Peter Krempa <pkrempa@redhat.com> --- docs/kbase/index.rst | 38 +++++++++++++++++++------------------- 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/docs/kbase/index.rst b/docs/kbase/index.rst index f9e42f211f..1494be1e77 100644 --- a/docs/kbase/index.rst +++ b/docs/kbase/index.rst @@ -5,37 +5,37 @@ Knowledge base Usage ----- -`Disk locking <locking.html>`__ - Ensuring exclusive guest access to disks with - `virtlockd <locking-lockd.html>`__ or - `Sanlock <locking-sanlock.html>`__ - `Secure usage <secureusage.html>`__ Secure usage of the libvirt APIs -`Protected virtualization on s390 <s390_protected_virt.html>`__ - Running secure s390 guests with IBM Secure Execution +`Backing chain management <backing_chains.html>`__ + Explanation of how disk backing chain specification impacts libvirt's + behaviour and basic troubleshooting steps of disk problems. -`Launch security <launch_security_sev.html>`__ - Securely launching VMs with AMD SEV +`Virtio-FS <virtiofs.html>`__ + Share a filesystem between the guest and the host -`Domain state capture <domainstatecapture.html>`__ - Comparison between different methods of capturing domain state +`Security with QEMU passthrough <qemu-passthrough-security.html>`__ + Examination of the security protections used for QEMU and how they need + configuring to allow use of QEMU passthrough with host files/devices. `RPM deployment <rpm-deployment.html>`__ Explanation of the different RPM packages and illustration of which to pick for installation -`Backing chain management <backing_chains.html>`__ - Explanation of how disk backing chain specification impacts libvirt's - behaviour and basic troubleshooting steps of disk problems. +`Domain state capture <domainstatecapture.html>`__ + Comparison between different methods of capturing domain state -`Security with QEMU passthrough <qemu-passthrough-security.html>`__ - Examination of the security protections used for QEMU and how they need - configuring to allow use of QEMU passthrough with host files/devices. +`Disk locking <locking.html>`__ + Ensuring exclusive guest access to disks with + `virtlockd <locking-lockd.html>`__ or + `Sanlock <locking-sanlock.html>`__ -`Virtio-FS <virtiofs.html>`__ - Share a filesystem between the guest and the host +`Protected virtualization on s390 <s390_protected_virt.html>`__ + Running secure s390 guests with IBM Secure Execution + +`Launch security <launch_security_sev.html>`__ + Securely launching VMs with AMD SEV `KVM real time <kvm-realtime.html>`__ Run real time workloads in guests on a KVM hypervisor -- 2.26.2
On Wed, Nov 04, 2020 at 18:01:52 +0100, Peter Krempa wrote:
Some patches are taken from an older series where we've discussed that the kbase page should look more like 'docs.html' as more articles appear, this series delivers that:
https://www.redhat.com/archives/libvir-list/2020-August/msg00172.html
... and a few other changes.
Final output:
https://pipo.sk.gitlab.io/-/libvirt/-/jobs/830387801/artifacts/website/docs....
Peter Krempa (9): docs: Fix title of 'docs' page docs: xslt: Use 'Link' rather than 'Permalink' in header links docs: css: Add a gray box around table of contents of RST based docs docs: kbase: Move index page to docs/kbase docs: kbase: Remove extra container from index page docs: kbase: Split articles into sections docs: xsl: Unify stylability of main container element docs: css: Modify appearance of the kbase directory page docs: kbase: Reorder some articles in the 'Usage' section
Ping?
On 11/4/20 6:01 PM, Peter Krempa wrote:
Some patches are taken from an older series where we've discussed that the kbase page should look more like 'docs.html' as more articles appear, this series delivers that:
https://www.redhat.com/archives/libvir-list/2020-August/msg00172.html
... and a few other changes.
Final output:
https://pipo.sk.gitlab.io/-/libvirt/-/jobs/830387801/artifacts/website/docs....
Peter Krempa (9): docs: Fix title of 'docs' page docs: xslt: Use 'Link' rather than 'Permalink' in header links docs: css: Add a gray box around table of contents of RST based docs docs: kbase: Move index page to docs/kbase docs: kbase: Remove extra container from index page docs: kbase: Split articles into sections docs: xsl: Unify stylability of main container element docs: css: Modify appearance of the kbase directory page docs: kbase: Reorder some articles in the 'Usage' section
docs/docs.html.in | 5 ++-- docs/index.html.in | 4 +-- docs/kbase.rst | 53 --------------------------------- docs/kbase/index.rst | 57 +++++++++++++++++++++++++++++++++++ docs/kbase/meson.build | 1 + docs/libvirt.css | 67 +++++++++++++++++++++++++++--------------- docs/meson.build | 1 - docs/page.xsl | 27 ++++++++++------- scripts/hvsupport.py | 2 +- 9 files changed, 124 insertions(+), 93 deletions(-) delete mode 100644 docs/kbase.rst create mode 100644 docs/kbase/index.rst
Reviewed-by: Michal Privoznik <mprivozn@redhat.com> Michal
participants (2)
-
Michal Privoznik -
Peter Krempa