[elbe-devel] [PATCH v2 0/9] docs: use sphinx for documentation generation

[Thomas Weißschuh]

The generation of the documentation is currently split between
asciidoc, xmlto, docbook, pandoc and sphinx.

Unify all this by using sphinx.
This makes the generation simpler to adapt, allows usage of more
expressive markup and unifies the HTML docs on elbe-rfs.org and in
/usr/share/doc/elbe-doc.

Signed-off-by: Thomas Weißschuh <thomas.weissschuh at linutronix.de>
---
Changes in v2:
- Reword commit messages

---
Thomas Weißschuh (9):
      docs: sphinx: avoid warning about missing _static directory
      docs: commit reST files
      docs: sphinx: generate diagrams via graphviz
      docs: sphinx: drop call to make
      docs: sphinx: introduce XML schema extension
      docs: sphinx: build manpages with sphinx
      docs: switch build over to sphinx
      treewide: clean up remnants of old documentation generation
      docs: sphinx: drop autogenerated anchors

 .gitignore                             |   8 -
 bash-completion                        |   7 +-
 debian/control                         |  10 +-
 debian/python3-elbe-bin.install        |   2 -
 debian/rules                           |   2 +-
 docs/Makefile                          | 139 +----
 docs/article-elbe-schema-reference.rst |   5 +
 docs/article-elbeoverview-en.rst       | 942 ++++++++++++++++++++++++++++++++
 docs/article-quickstart.rst            | 520 ++++++++++++++++++
 docs/asciidoc.conf                     |  97 ----
 docs/conf.py                           |  23 +-
 docs/elbe-add.rst                      |  43 ++
 docs/elbe-add.txt                      |  39 --
 docs/elbe-buildchroot.rst              |  99 ++++
 docs/elbe-buildchroot.txt              |  98 ----
 docs/elbe-buildsdk.rst                 |  39 ++
 docs/elbe-buildsdk.txt                 |  39 --
 docs/elbe-buildsysroot.rst             |  64 +++
 docs/elbe-buildsysroot.txt             |  65 ---
 docs/elbe-check_updates.rst            |  74 +++
 docs/elbe-check_updates.txt            |  69 ---
 docs/elbe-chg_archive.rst              |  68 +++
 docs/elbe-chg_archive.txt              |  63 ---
 docs/elbe-chroot.rst                   |  79 +++
 docs/elbe-chroot.txt                   |  82 ---
 docs/elbe-control.rst                  | 236 ++++++++
 docs/elbe-control.txt                  | 280 ----------
 docs/elbe-daemon.rst                   |  38 ++
 docs/elbe-daemon.txt                   |  38 --
 docs/elbe-db.rst                       | 139 +++++
 docs/elbe-db.txt                       | 133 -----
 docs/elbe-debianize.rst                |  73 +++
 docs/elbe-debianize.txt                |  70 ---
 docs/elbe-diff.rst                     |  38 ++
 docs/elbe-diff.txt                     |  37 --
 docs/elbe-fetch_initvm_pkgs.rst        |  75 +++
 docs/elbe-fetch_initvm_pkgs.txt        |  75 ---
 docs/elbe-gen_update.rst               |  74 +++
 docs/elbe-gen_update.txt               |  74 ---
 docs/elbe-genlicence.rst               |  61 +++
 docs/elbe-genlicence.txt               |  61 ---
 docs/elbe-get_archive.rst              |  44 ++
 docs/elbe-get_archive.txt              |  46 --
 docs/elbe-hdimg.rst                    |  63 +++
 docs/elbe-hdimg.txt                    |  63 ---
 docs/elbe-init.rst                     |  85 +++
 docs/elbe-init.txt                     |  85 ---
 docs/elbe-initvm.rst                   | 156 ++++++
 docs/elbe-initvm.txt                   | 168 ------
 docs/elbe-mkcdrom.rst                  |  92 ++++
 docs/elbe-mkcdrom.txt                  |  92 ----
 docs/elbe-parselicence.rst             | 356 ++++++++++++
 docs/elbe-parselicence.txt             | 349 ------------
 docs/elbe-pbuilder.rst                 | 151 ++++++
 docs/elbe-pbuilder.txt                 | 153 ------
 docs/elbe-pkgdiff.rst                  |  40 ++
 docs/elbe-pkgdiff.txt                  |  40 --
 docs/elbe-preprocess.rst               |  45 ++
 docs/elbe-preprocess.txt               |  43 --
 docs/elbe-prjrepo.rst                  |  75 +++
 docs/elbe-prjrepo.txt                  |  79 ---
 docs/elbe-remove_sign.rst              |  44 ++
 docs/elbe-remove_sign.txt              |  44 --
 docs/elbe-repodir.rst                  |  75 +++
 docs/elbe-repodir.txt                  |  73 ---
 docs/elbe-setsel.rst                   |  65 +++
 docs/elbe-setsel.txt                   |  57 --
 docs/elbe-show.rst                     |  47 ++
 docs/elbe-show.txt                     |  48 --
 docs/elbe-sign.rst                     |  50 ++
 docs/elbe-sign.txt                     |  51 --
 docs/elbe-toolchainextract.rst         |  92 ++++
 docs/elbe-toolchainextract.txt         |  90 ---
 docs/elbe-updated.rst                  |  75 +++
 docs/elbe-updated.txt                  |  74 ---
 docs/elbe-validate.rst                 |  40 ++
 docs/elbe-validate.txt                 |  42 --
 docs/elbe-xsdtoasciidoc.txt            |  49 --
 docs/elbe.rst                          | 105 ++++
 docs/elbe.txt                          | 108 ----
 docs/elbeoverview-en.txt               | 965 ---------------------------------
 docs/ext/xmlschema.py                  | 215 ++++++++
 docs/manpage-1.72.xsl                  |  14 -
 docs/manpage-base-url.xsl.in           |  10 -
 docs/manpage-base.xsl                  |  35 --
 docs/manpage-normal.xsl                |  13 -
 docs/quickstart.txt                    | 504 -----------------
 elbepack/commands/xsdtoasciidoc.py     |  39 --
 elbepack/xsdtoasciidoc.mako            | 175 ------
 setup.py                               |   1 -
 90 files changed, 4615 insertions(+), 4988 deletions(-)
---
base-commit: 41747ffae99073c8ae1380c202c2eef740bf570a
change-id: 20240325-docs-ee68c41993dc

Best regards,
-- 
Thomas Weißschuh <thomas.weissschuh at linutronix.de>