[PATCH 00/11] docs: Convert some pages to rST and clean up (part 4)

Peter Krempa posted 11 patches 2 years ago
Test syntax-check passed
Failed in applying to current master (apply log)
docs/api.rst                                  |   2 +-
docs/css/libvirt.css                          |  17 +-
docs/docs.html.in                             | 188 ----
docs/docs.rst                                 | 163 ++++
docs/go/meson.build                           |   5 +-
docs/internals.html.in                        | 119 ---
docs/internals/command.html.in                | 596 ------------
docs/internals/eventloop.html.in              | 106 --
docs/internals/locking.html.in                | 267 -----
docs/internals/rpc.html.in                    | 914 ------------------
docs/kbase/index.rst                          |  34 +-
docs/kbase/internals/command.rst              | 465 +++++++++
docs/kbase/internals/eventloop.rst            |  84 ++
.../incremental-backup.rst}                   |   0
docs/kbase/internals/locking.rst              | 190 ++++
docs/{ => kbase}/internals/meson.build        |  20 +-
.../migration.rst}                            |   0
docs/kbase/internals/overview.rst             | 102 ++
docs/kbase/internals/rpc.rst                  | 781 +++++++++++++++
docs/kbase/meson.build                        |  10 +-
docs/manpages/meson.build                     |   5 +-
docs/meson.build                              |  16 +-
docs/site.xsl                                 |  12 +-
docs/subsite.xsl                              |  24 -
24 files changed, 1860 insertions(+), 2260 deletions(-)
delete mode 100644 docs/docs.html.in
create mode 100644 docs/docs.rst
delete mode 100644 docs/internals.html.in
delete mode 100644 docs/internals/command.html.in
delete mode 100644 docs/internals/eventloop.html.in
delete mode 100644 docs/internals/locking.html.in
delete mode 100644 docs/internals/rpc.html.in
create mode 100644 docs/kbase/internals/command.rst
create mode 100644 docs/kbase/internals/eventloop.rst
rename docs/kbase/{incrementalbackupinternals.rst => internals/incremental-backup.rst} (100%)
create mode 100644 docs/kbase/internals/locking.rst
rename docs/{ => kbase}/internals/meson.build (69%)
rename docs/kbase/{migrationinternals.rst => internals/migration.rst} (100%)
create mode 100644 docs/kbase/internals/overview.rst
create mode 100644 docs/kbase/internals/rpc.rst
delete mode 100644 docs/subsite.xsl
[PATCH 00/11] docs: Convert some pages to rST and clean up (part 4)
Posted by Peter Krempa 2 years ago
This part focuses on 'internals' documents along comes simplification of
the XSL usage for 'href_base' and conversion of the 'docs/docs'
directory page to RST as I was modifying it in the process.

Additionally this series actually makes use of the 'internals' page
which was not linked previously.

Peter Krempa (11):
  kbase: index: Split off 'internals' section
  docs: Simplify passing of 'href_base' XSL variable
  docs: kbase: Section of 'internals' documents into a subfolder
  docs: Convert 'docs' index page to rst
  docs: Convert 'internals/command' to rst and move it to
    'kbase/internals'
  docs: Convert 'internals/eventloop' page to rst and move it to
    'kbase/internals'
  docs: Convert 'internals/locking' page to rst and move it to
    'kbase/internals'
  docs: Convert 'internals/rpc' page to RST and move it to
    'kbase/internals'
  docs: Remove empty 'internals' subfolder
  docs: Convert 'internals' to RST and move it to
    'kbase/internal/overview.rst'
  docs: kbase: internals: Make 'overview' page useful and link to it

 docs/api.rst                                  |   2 +-
 docs/css/libvirt.css                          |  17 +-
 docs/docs.html.in                             | 188 ----
 docs/docs.rst                                 | 163 ++++
 docs/go/meson.build                           |   5 +-
 docs/internals.html.in                        | 119 ---
 docs/internals/command.html.in                | 596 ------------
 docs/internals/eventloop.html.in              | 106 --
 docs/internals/locking.html.in                | 267 -----
 docs/internals/rpc.html.in                    | 914 ------------------
 docs/kbase/index.rst                          |  34 +-
 docs/kbase/internals/command.rst              | 465 +++++++++
 docs/kbase/internals/eventloop.rst            |  84 ++
 .../incremental-backup.rst}                   |   0
 docs/kbase/internals/locking.rst              | 190 ++++
 docs/{ => kbase}/internals/meson.build        |  20 +-
 .../migration.rst}                            |   0
 docs/kbase/internals/overview.rst             | 102 ++
 docs/kbase/internals/rpc.rst                  | 781 +++++++++++++++
 docs/kbase/meson.build                        |  10 +-
 docs/manpages/meson.build                     |   5 +-
 docs/meson.build                              |  16 +-
 docs/site.xsl                                 |  12 +-
 docs/subsite.xsl                              |  24 -
 24 files changed, 1860 insertions(+), 2260 deletions(-)
 delete mode 100644 docs/docs.html.in
 create mode 100644 docs/docs.rst
 delete mode 100644 docs/internals.html.in
 delete mode 100644 docs/internals/command.html.in
 delete mode 100644 docs/internals/eventloop.html.in
 delete mode 100644 docs/internals/locking.html.in
 delete mode 100644 docs/internals/rpc.html.in
 create mode 100644 docs/kbase/internals/command.rst
 create mode 100644 docs/kbase/internals/eventloop.rst
 rename docs/kbase/{incrementalbackupinternals.rst => internals/incremental-backup.rst} (100%)
 create mode 100644 docs/kbase/internals/locking.rst
 rename docs/{ => kbase}/internals/meson.build (69%)
 rename docs/kbase/{migrationinternals.rst => internals/migration.rst} (100%)
 create mode 100644 docs/kbase/internals/overview.rst
 create mode 100644 docs/kbase/internals/rpc.rst
 delete mode 100644 docs/subsite.xsl

-- 
2.35.1
Re: [PATCH 00/11] docs: Convert some pages to rST and clean up (part 4)
Posted by Michal Prívozník 2 years ago
On 4/7/22 16:00, Peter Krempa wrote:
> This part focuses on 'internals' documents along comes simplification of
> the XSL usage for 'href_base' and conversion of the 'docs/docs'
> directory page to RST as I was modifying it in the process.
> 
> Additionally this series actually makes use of the 'internals' page
> which was not linked previously.
> 
> Peter Krempa (11):
>   kbase: index: Split off 'internals' section
>   docs: Simplify passing of 'href_base' XSL variable
>   docs: kbase: Section of 'internals' documents into a subfolder
>   docs: Convert 'docs' index page to rst
>   docs: Convert 'internals/command' to rst and move it to
>     'kbase/internals'
>   docs: Convert 'internals/eventloop' page to rst and move it to
>     'kbase/internals'
>   docs: Convert 'internals/locking' page to rst and move it to
>     'kbase/internals'
>   docs: Convert 'internals/rpc' page to RST and move it to
>     'kbase/internals'
>   docs: Remove empty 'internals' subfolder
>   docs: Convert 'internals' to RST and move it to
>     'kbase/internal/overview.rst'
>   docs: kbase: internals: Make 'overview' page useful and link to it
> 
>  docs/api.rst                                  |   2 +-
>  docs/css/libvirt.css                          |  17 +-
>  docs/docs.html.in                             | 188 ----
>  docs/docs.rst                                 | 163 ++++
>  docs/go/meson.build                           |   5 +-
>  docs/internals.html.in                        | 119 ---
>  docs/internals/command.html.in                | 596 ------------
>  docs/internals/eventloop.html.in              | 106 --
>  docs/internals/locking.html.in                | 267 -----
>  docs/internals/rpc.html.in                    | 914 ------------------
>  docs/kbase/index.rst                          |  34 +-
>  docs/kbase/internals/command.rst              | 465 +++++++++
>  docs/kbase/internals/eventloop.rst            |  84 ++
>  .../incremental-backup.rst}                   |   0
>  docs/kbase/internals/locking.rst              | 190 ++++
>  docs/{ => kbase}/internals/meson.build        |  20 +-
>  .../migration.rst}                            |   0
>  docs/kbase/internals/overview.rst             | 102 ++
>  docs/kbase/internals/rpc.rst                  | 781 +++++++++++++++
>  docs/kbase/meson.build                        |  10 +-
>  docs/manpages/meson.build                     |   5 +-
>  docs/meson.build                              |  16 +-
>  docs/site.xsl                                 |  12 +-
>  docs/subsite.xsl                              |  24 -
>  24 files changed, 1860 insertions(+), 2260 deletions(-)
>  delete mode 100644 docs/docs.html.in
>  create mode 100644 docs/docs.rst
>  delete mode 100644 docs/internals.html.in
>  delete mode 100644 docs/internals/command.html.in
>  delete mode 100644 docs/internals/eventloop.html.in
>  delete mode 100644 docs/internals/locking.html.in
>  delete mode 100644 docs/internals/rpc.html.in
>  create mode 100644 docs/kbase/internals/command.rst
>  create mode 100644 docs/kbase/internals/eventloop.rst
>  rename docs/kbase/{incrementalbackupinternals.rst => internals/incremental-backup.rst} (100%)
>  create mode 100644 docs/kbase/internals/locking.rst
>  rename docs/{ => kbase}/internals/meson.build (69%)
>  rename docs/kbase/{migrationinternals.rst => internals/migration.rst} (100%)
>  create mode 100644 docs/kbase/internals/overview.rst
>  create mode 100644 docs/kbase/internals/rpc.rst
>  delete mode 100644 docs/subsite.xsl
> 

I'm going to miss docs.html that fits into one screen, but I can live
with long version too.

Reviewed-by: Michal Privoznik <mprivozn@redhat.com>

Michal
Re: [PATCH 00/11] docs: Convert some pages to rST and clean up (part 4)
Posted by Peter Krempa 2 years ago
On Fri, Apr 08, 2022 at 13:23:38 +0200, Michal Prívozník wrote:
> On 4/7/22 16:00, Peter Krempa wrote:
> > This part focuses on 'internals' documents along comes simplification of
> > the XSL usage for 'href_base' and conversion of the 'docs/docs'
> > directory page to RST as I was modifying it in the process.
> > 
> > Additionally this series actually makes use of the 'internals' page
> > which was not linked previously.

[...]

> > 
> 
> I'm going to miss docs.html that fits into one screen, but I can live
> with long version too.

After some off-line debugging with Michal we've figured out that a newer
version of docutils generates a '<section>' instead of a '<div
class="section">', so this problem shows up only on some instances.

I'll post a fix later.

> 
> Reviewed-by: Michal Privoznik <mprivozn@redhat.com>
> 
> Michal
>