From 5ff58a0ce7a6ad452919a86a05e27427ccf1f27b Mon Sep 17 00:00:00 2001 From: Peter Krempa Date: Wed, 3 Aug 2022 14:59:14 +0200 Subject: [PATCH] docs: index: Convert to 'rst' MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Final piece of conversion of our non-generated pages to 'rst'. Special raw HTML is used for adding the appropriate code to fetch the blog planet. Signed-off-by: Peter Krempa Reviewed-by: Ján Tomko --- docs/css/libvirt.css | 35 +++++++++++------- docs/css/mobile.css | 8 ++-- docs/index.html.in | 87 -------------------------------------------- docs/index.rst | 70 +++++++++++++++++++++++++++++++++++ docs/meson.build | 12 +----- 5 files changed, 98 insertions(+), 114 deletions(-) delete mode 100644 docs/index.html.in create mode 100644 docs/index.rst diff --git a/docs/css/libvirt.css b/docs/css/libvirt.css index 2f4daa4690..8dfec17047 100644 --- a/docs/css/libvirt.css +++ b/docs/css/libvirt.css @@ -105,8 +105,8 @@ main, width: 70em; } -main#index, -#index.document, +main#the-virtualization-api, +#the-virtualization-api.document, main#hvsupport, #hvsupport.document, main#documentation, @@ -319,7 +319,8 @@ h6:hover > a.headerlink { visibility: visible; } -div.panel, +#the-virtualization-api section, +#the-virtualization-api .section, #documentation section, #documentation .section, #knowledge-base section, @@ -332,7 +333,8 @@ div.panel, background: rgb(230, 230, 230); } -div.panel h2, +#the-virtualization-api section h2, +#the-virtualization-api .section h1, #documentation section h2, #documentation .section h1, #knowledge-base section h2, @@ -347,7 +349,7 @@ div.panel h2, font-size: 1.6em; } -#index.document h1 { +#the-virtualization-api > h1 { border: 0px; text-indent: 100%; white-space: nowrap; overflow: hidden; background: url(../logos/logo-banner-dark-800.png) no-repeat center center; @@ -412,21 +414,21 @@ br.clear { font-size: smaller; } -div.panel dd, +#the-virtualization-api dd, #documentation dd, #knowledge-base dd { font-size: smaller; } -div.panel a, +#the-virtualization-api a, #documentation a, #knowledge-base a { text-decoration: none; } -div.panel ul, -div.panel p, -div.panel dl, +#the-virtualization-api ul, +#the-virtualization-api p, +#the-virtualization-api dl, #documentation ul, #documentation p, #documentation dl, @@ -437,19 +439,26 @@ div.panel dl, margin: 0px; } -div.panel ul, +#the-virtualization-api li p +{ + padding-left: 0.5em; + padding-top: 0px; + padding-bottom: 0px; +} + +#the-virtualization-api ul, #documentation ul, #knowledge-base ul { margin-left: 1em; } -div.panel dt, +#the-virtualization-api dt, #documentation dt, #knowledge-base dt { margin: 0px; } -div.panel dd, +#the-virtualization-api dd, #documentation dd, #knowledge-base dd { margin: 0px; diff --git a/docs/css/mobile.css b/docs/css/mobile.css index 1b0bd8b350..2e223f468e 100644 --- a/docs/css/mobile.css +++ b/docs/css/mobile.css @@ -20,7 +20,8 @@ #search form { padding: 5px; } - #index h1 { + #the-virtualization-api > h1, + #the-virtualization-api > h2 { display: none; } #jumplinks { @@ -87,11 +88,12 @@ #body { margin-top: 180px; } + #the-virtualization-api section, + #the-virtualization-api .section, #documentation section, #documentation .section, #knowledge-base section, - #knowledge-base .section, - div.panel { + #knowledge-base .section { width: 100%; margin-left: 0px; float: none; diff --git a/docs/index.html.in b/docs/index.html.in deleted file mode 100644 index 3c065badb7..0000000000 --- a/docs/index.html.in +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - - -

The virtualization API

- -
-

Introduction

-

- The libvirt project: -

- -

Recent / forthcoming release changes

-
- -
-

Quick Links

- -
-
New contributors
-
Get involved in the libvirt community & student outreach programs
- -
Security vulnerabilities
-
View security notices and report vulnerabilities to the libvirt security response team
- -
Bug reporting
-
View and report bugs in libvirt packages
- -
XML configuration
-
Description of the XML schemas for - domains, - networks, - network filtering, - storage, - storage encryption, - capabilities, - domain capabilities, - storage pool capabilities, - node devices, - secrets, - snapshots, - checkpoints, - backup jobs
-
Wiki
-
Read further community contributed content
- -
Knowledge base
-
Learn more about libvirt through knowledge base
-
-
- -
-

Blog Planet

-
-
- -

- Read more on the Virt Tools blog planet -

-
- -
- - - diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000000..d55c4bb94d --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,70 @@ +====================== +The virtualization API +====================== + +Introduction +------------ + +The libvirt project: + +- is a toolkit to manage `virtualization platforms `__ +- is accessible from C, Python, Perl, Go and more +- is licensed under open source licenses +- supports + `KVM `__, + `Hypervisor.framework `__, + `QEMU `__, + `Xen `__, + `Virtuozzo `__, + `VMWare ESX `__, + `LXC `__, + `BHyve `__ and + `more `__ +- targets Linux, FreeBSD, `Windows `__ and `macOS `__ +- is used by many `applications `__ + +Recent / forthcoming `release changes `__ + +Quick Links +----------- + +`New contributors `__ + Get involved in the libvirt community & student outreach programs +`Security vulnerabilities `__ + View security notices and report vulnerabilities to the libvirt security + response team +`Bug reporting `__ + View and report bugs in libvirt packages +`XML configuration `__ + Description of the XML schemas for + `domains `__, + `networks `__, + `network filtering `__, + `storage `__, + `storage encryption `__, + `capabilities `__, + `domain capabilities `__, + `storage pool capabilities `__, + `node devices `__, + `secrets `__, + `snapshots `__, + `checkpoints `__, + `backup jobs `__ +`Wiki `__ + Read further community contributed content +`Knowledge base `__ + Learn more about libvirt through knowledge base + +Blog Planet +----------- + +.. raw:: html + + +
+ +Read more on the `Virt Tools blog planet `__ diff --git a/docs/meson.build b/docs/meson.build index 8edb93333a..2f0ecb2272 100644 --- a/docs/meson.build +++ b/docs/meson.build @@ -17,10 +17,6 @@ docs_assets = [ 'mstile-150x150.png', ] -docs_html_in_files = [ - 'index', -] - docs_rst_files = [ 'aclpolkit', 'advanced-tests', @@ -84,6 +80,7 @@ docs_rst_files = [ 'governance', 'hacking', 'hooks', + 'index', 'issue-handling', 'libvirt-go', 'libvirt-go-xml', @@ -230,13 +227,6 @@ html_xslt_gen = [] # source - source filename relative to repository root (optional, if there is no source) # depends - explicit dependency on other input (optional) -foreach name : docs_html_in_files - html_xslt_gen += { - 'name': name, - 'source': 'docs' / name + '.html.in', - } -endforeach - foreach name : docs_rst_files rst_file = '@0@.rst'.format(name) html_xslt_gen += {