Mirror/pmbootstrap
1
0
Fork 1
mirror of https://gitlab.postmarketos.org/postmarketOS/pmbootstrap.git synced 2025-07-12 19:09:56 +03:00
Code Issues Wiki Activity

Improvements to documentation (MR 2440)

Browse source 
* 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
Download patch file Download diff file Expand all files Collapse all files

16
docs/api/pmb.build.rst
View file

@ -12,6 +12,14 @@ pmb.build.autodetect module
:undoc-members:
:show-inheritance:
pmb.build.backend module
------------------------
.. automodule:: pmb.build.backend
:members:
:undoc-members:
:show-inheritance:
pmb.build.checksum module
-------------------------
@ -60,6 +68,14 @@ pmb.build.other module
:undoc-members:
:show-inheritance:
pmb.build._package module
-------------------------
.. automodule:: pmb.build._package
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------

14
docs/api/pmb.chroot.rst
View file

@ -68,10 +68,10 @@ pmb.chroot.other module
:undoc-members:
:show-inheritance:
pmb.chroot.root module
----------------------
pmb.chroot.run module
---------------------
.. automodule:: pmb.chroot.root
.. automodule:: pmb.chroot.run
:members:
:undoc-members:
:show-inheritance:
@ -84,14 +84,6 @@ pmb.chroot.shutdown module
:undoc-members:
:show-inheritance:
pmb.chroot.user module
----------------------
.. automodule:: pmb.chroot.user
:members:
:undoc-members:
:show-inheritance:
pmb.chroot.zap module
---------------------

101
docs/api/pmb.commands.rst Normal file
View file

@ -0,0 +1,101 @@
pmb.commands package
====================
Submodules
----------
pmb.commands.aportgen module
----------------------------
.. automodule:: pmb.commands.aportgen
:members:
:undoc-members:
:show-inheritance:
pmb.commands.base module
------------------------
.. automodule:: pmb.commands.base
:members:
:undoc-members:
:show-inheritance:
pmb.commands.index module
-------------------------
.. automodule:: pmb.commands.index
:members:
:undoc-members:
:show-inheritance:
pmb.commands.kconfig_check module
---------------------------------
.. automodule:: pmb.commands.kconfig_check
:members:
:undoc-members:
:show-inheritance:
pmb.commands.kconfig_edit module
--------------------------------
.. automodule:: pmb.commands.kconfig_edit
:members:
:undoc-members:
:show-inheritance:
pmb.commands.log module
-----------------------
.. automodule:: pmb.commands.log
:members:
:undoc-members:
:show-inheritance:
pmb.commands.pkgrel_bump module
-------------------------------
.. automodule:: pmb.commands.pkgrel_bump
:members:
:undoc-members:
:show-inheritance:
pmb.commands.pkgver_bump module
-------------------------------
.. automodule:: pmb.commands.pkgver_bump
:members:
:undoc-members:
:show-inheritance:
pmb.commands.pull module
------------------------
.. automodule:: pmb.commands.pull
:members:
:undoc-members:
:show-inheritance:
pmb.commands.repo_bootstrap module
----------------------------------
.. automodule:: pmb.commands.repo_bootstrap
:members:
:undoc-members:
:show-inheritance:
pmb.commands.shutdown module
----------------------------
.. automodule:: pmb.commands.shutdown
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: pmb.commands
:members:
:undoc-members:
:show-inheritance:

30
docs/api/pmb.config.rst
View file

@ -4,6 +4,14 @@ pmb.config package
Submodules
----------
pmb.config.file module
----------------------
.. automodule:: pmb.config.file
:members:
:undoc-members:
:show-inheritance:
pmb.config.init module
----------------------
@ -12,18 +20,10 @@ pmb.config.init module
:undoc-members:
:show-inheritance:
pmb.config.load module
----------------------
pmb.config.other module
-----------------------
.. automodule:: pmb.config.load
:members:
:undoc-members:
:show-inheritance:
pmb.config.merge\_with\_args module
-----------------------------------
.. automodule:: pmb.config.merge_with_args
.. automodule:: pmb.config.other
:members:
:undoc-members:
:show-inheritance:
@ -36,14 +36,6 @@ pmb.config.pmaports module
:undoc-members:
:show-inheritance:
pmb.config.save module
----------------------
.. automodule:: pmb.config.save
:members:
:undoc-members:
:show-inheritance:
pmb.config.sudo module
----------------------

85
docs/api/pmb.core.rst Normal file
View file

@ -0,0 +1,85 @@
pmb.core package
=================
Submodules
----------
pmb.core.apkindex_block module
------------------------------
.. automodule:: pmb.core.apkindex_block
:members:
:undoc-members:
:show-inheritance:
pmb.core.arch module
--------------------
.. automodule:: pmb.core.arch
:members:
:undoc-members:
:show-inheritance:
pmb.core.chroot module
----------------------
.. automodule:: pmb.core.chroot
:members:
:undoc-members:
:show-inheritance:
pmb.core.config module
----------------------
.. automodule:: pmb.core.config
:members:
:undoc-members:
:show-inheritance:
pmb.core.context module
-----------------------
.. automodule:: pmb.core.context
:members:
:undoc-members:
:show-inheritance:
pmb.core.crosstool module
-------------------------
.. automodule:: pmb.core.crosstool
:members:
:undoc-members:
:show-inheritance:
pmb.core.dps module
-------------------
.. automodule:: pmb.core.dps
:members:
:undoc-members:
:show-inheritance:
pmb.core.package_metadata module
--------------------------------
.. automodule:: pmb.core.package_metadata
:members:
:undoc-members:
:show-inheritance:
pmb.core.pkgrepo module
-----------------------
.. automodule:: pmb.core.pkgrepo
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: pmb.core
:members:
:undoc-members:
:show-inheritance:

16
docs/api/pmb.helpers.rst
View file

@ -44,6 +44,14 @@ pmb.helpers.devices module
:undoc-members:
:show-inheritance:
pmb.helpers.exceptions module
-----------------------------
.. automodule:: pmb.helpers.exceptions
:members:
:undoc-members:
:show-inheritance:
pmb.helpers.file module
-----------------------
@ -172,6 +180,14 @@ pmb.helpers.status module
:undoc-members:
:show-inheritance:
pmb.helpers.toml module
-----------------------
.. automodule:: pmb.helpers.toml
:members:
:undoc-members:
:show-inheritance:
pmb.helpers.ui module
---------------------

8
docs/api/pmb.install.rst
View file

@ -52,6 +52,14 @@ pmb.install.ui module
:undoc-members:
:show-inheritance:
pmb.install._install module
---------------------------
.. automodule:: pmb.install._install
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------

24
docs/api/pmb.parse.rst
View file

@ -12,14 +12,6 @@ pmb.parse.apkindex module
:undoc-members:
:show-inheritance:
pmb.parse.arch module
---------------------
.. automodule:: pmb.parse.arch
:members:
:undoc-members:
:show-inheritance:
pmb.parse.arguments module
--------------------------
@ -76,6 +68,14 @@ pmb.parse.kconfig module
:undoc-members:
:show-inheritance:
pmb.parse.kconfigcheck module
-----------------------------
.. automodule:: pmb.parse.kconfigcheck
:members:
:undoc-members:
:show-inheritance:
pmb.parse.version module
------------------------
@ -84,6 +84,14 @@ pmb.parse.version module
:undoc-members:
:show-inheritance:
pmb.parse._apkbuild module
--------------------------
.. automodule:: pmb.parse._apkbuild
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------

3
docs/api/pmb.rst
View file

@ -11,7 +11,9 @@ Subpackages
pmb.build
pmb.chroot
pmb.ci
pmb.commands
pmb.config
pmb.core
pmb.export
pmb.flasher
pmb.helpers
@ -20,6 +22,7 @@ Subpackages
pmb.parse
pmb.qemu
pmb.sideload
pmb.types
Module contents
---------------

10
docs/api/pmb.types.rst Normal file
View file

@ -0,0 +1,10 @@
pmb.types package
=================
Module contents
---------------
.. automodule:: pmb.types
:members:
:undoc-members:
:show-inheritance: