Improvements to documentation (MR 2440)

* Make sure all Python modules are documented by adding a bit of shell
  to .ci/docs.sh
* Remove non-existing module references from .rst
* Fix various warnings from sphinx by adjusting Python docstrings
* Add class member docs to ApkindexBlock
This commit is contained in:
Luca Weiss 2024-10-19 18:01:36 +02:00 committed by Caleb Connolly
parent c7a97df79a
commit 35cd64086f
No known key found for this signature in database
GPG key ID: 0583312B195F64B6
15 changed files with 302 additions and 52 deletions

View file

@ -104,6 +104,7 @@ def umount_all(folder: Path):
def mount_device_rootfs(chroot_rootfs: Chroot, chroot_base: Chroot = Chroot.native()) -> PurePath:
"""
Mount the device rootfs.
:param chroot_rootfs: the chroot where the rootfs that will be
installed on the device has been created (e.g.
"rootfs_qemu-amd64")